🧰
Developer
  • ENGAGE SDK overview
  • Setting up the ENGAGE SDK
    • Registering as an ENGAGE developer
    • Setting up your local git repository
    • Installing the Unity Editor
    • Opening the ENGAGE SDK Unity project
    • Checking for SDK updates
    • Installing a platform build module
  • ENGAGE SDK project folders
  • General guidelines for 3D models
    • Optimizing 3D models
  • Locations
    • Guidelines for locations
    • Creating a new location
    • Building a location bundle
    • Testing a location locally on Windows
    • Configuring an object as a teleport target
    • Configuring the start position
    • Seats
      • Creating a seat
      • Using the summon to seat system
    • Network states
      • Network State Manager
      • Location Network States
      • Example network state configurations
        • Network state toggle object
        • Network state animation start/stop
        • Network state change animation
          • Creating an animation in Unity
          • Using Animator.Play(string)
          • Defining Animator transitions
          • Using Animator.SetTrigger(string)
        • Network state sync animation
        • Network state position toggle
        • Network state automatic door
        • Network state toggle skybox
        • Network state change materials
    • Adding grabable objects to a location
      • Resetting network objects with a button
      • Resetting network objects when out of bounds
    • Locations reference information
      • Basic requirements for a location
  • Immersive Effects (IFX)
    • Guidelines for IFX
    • Creating an IFX
    • Building an IFX bundle
    • Testing IFX locally on Windows
    • Specialized IFX
      • Animated IFX
        • Animation overrides
          • Legacy animations
          • Animator animations
          • Configuring additional Effect Life Run Control properties
      • Audio IFX
      • Interactive IFX
  • List of available prefabs
  • Available scripts
    • External Video Player
  • Profiling
  • Publishing to ENGAGE
    • Publishing checklists
    • Pushing files to your GitHub repository
  • AFX
    • Getting started
      • Changelog
    • AFX Graphs
      • Creating an AFX graph
      • Editing an AFX graph
      • Navigation and keyboard shortcuts
      • Adding an AFX graph to a game object
      • Nodes
      • Ports
      • Connections
      • Flows
        • Starting a flow
        • Using multiple flows
        • Chaining flows
        • Controlling flows
      • References
      • Using AFX Events
    • Networking AFX
      • Network State Modules
      • Ownership of networked objects
    • Animation curves
    • Node dictionary
      • ENGAGE
        • AFX Companion
          • Constant Collision
          • Grab Object
          • PathData
        • Networking
          • Network State Modules
        • Physics
        • Player
        • Seat
      • Events
        • Collision
        • Unity
        • AFX Events
      • Flow
      • Reference
      • Unity
        • Component
          • Animation
            • Set Parameters
          • Audio
            • Audio Reverb Zone
            • Audio Source
          • Collider
          • FX
          • Rendering
            • Camera
            • Light
            • Material
          • UI
        • Constraint
        • GameObject
        • Input
        • Physics
          • Raycast
            • Layer Mask
          • RigidBody
            • Joint
              • Hinge
              • Spring
          • Wheel Collider
        • Time
        • Transform
          • Get
          • Set
          • Space Switching
      • Variable
        • Bool
        • Comparison
        • Float
        • Int
        • List
        • Math
          • MathF
        • String
        • Unity Component
        • Vector
          • Quaternion
          • Vector2
          • Vector 3
            • Vector3 Math
    • Sample graphs
Powered by GitBook
On this page
  • Boolean cast nodes
  • Boolean logic nodes
  • Logic Bool Changed
  • Example
  • Bool Constant
  • Get Bool
  • Invert Bool
  • Set Bool
  1. AFX
  2. Node dictionary
  3. Variable

Bool

PreviousVariableNextComparison

Last updated 7 months ago

Boolean cast nodes

You can use a Boolean cast node to convert a Boolean value to a float, an integer, or a string. In each case you can choose how the Boolean true or false value is represented in the target type.

For example, the default outputs for the Bool To String node are "true" and "false", but you could change them to "on" and "off", or "open" and "closed", or any other pair of strings.

Inputs:

Name
Type
Description

Input

Boolean

The value to be converted.

True Value

<varies> [editable]

The value to output if the input is true.

False Value

<varies> [editable]

The value to output if the input is false.

Outputs:

Name
Type
Description

Output

<varies>

The converted value. The output depends on the chosen node, and is either a float, an integer, or a string.

Boolean logic nodes

Perform Boolean logic operations on the provided inputs. All inputs and outputs are Boolean values.

Name
Operation

Bool And

Output is true if both A and B are true.

Bool Or

Output is true if either A or B are true.

If you need a node that's equivalent to a Not logical operation, see Invert Bool.

Logic Bool Changed

Outputs true in the frame where the input value changes from true to false or from false to true.

Inputs:

Name
Type
Description

Input

Boolean

The Boolean value to monitor.

Outputs:

Name
Type
Description

Output

Boolean

True when the Input changes, but resets to false at the end of the frame.

Example

In the following example, the referenced float is incremented by one each time that the referenced Boolean changes.

Bool Constant

Outputs a true or false Boolean value. An AFX graph cannot change the value of this node.

You can open an AFX graph to change the value of this node in the Unity Editor.

Outputs:

Name
Type
Description

Output

Boolean [editable]

A true or false value.

Get Bool

Converts a reference to a Boolean component to a Boolean value.

Inputs:

Name
Type
Description

Bool Component

Bool Component

Reference to a Boolean component.

Outputs:

Name
Type
Description

Bool Out

Boolean

The true or false value of the Boolean component.

Invert Bool

Inverts a Boolean value. If the input is true, the output is false. If the input is false, the output is true.

Inputs:

Name
Type
Description

Input

Boolean

The value to be inverted.

Outputs:

Name
Type
Description

Output

Boolean

The inverted value of the Input.

Set Bool

Sets the value of a Boolean component.

Inputs:

Name
Type
Description

Enter

Flow

Flow to activate the node.

Bool Component

Boolean component

Reference to the Boolean component for which you want to set the value.

Value In

Boolean [editable]

The value that the Boolean component will be set to.

Outputs:

Name
Type
Description

Exit

Flow

Continue the activating flow.

Output

Boolean

Repeats the Value In value as an output.

The available nodes to cast a Boolean to another data type
The available Boolean logic nodes
Logic Bool Changed node
Example graph to increment a float each time that a Boolean changes