🧰
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
  • 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
  • Mouse
  • Input get nodes
  1. AFX
  2. Node dictionary
  3. Unity

Input

PreviousGameObjectNextPhysics

Last updated 7 months ago

You can use input nodes to respond to user inputs. For more information, refer to the page in the Unity documentation.

Mouse

You can use the mouse input nodes to branch a flow based on mouse button states.

Inputs:

Name
Type
Description

Enter

Flow

Flow to activate the node.

Outputs:

Name
Type
Description

Exit

Flow

Continue the activating flow.

Left Click

Flow

Continue the activating flow based on the state of the left mouse button.

Middle Click

Flow

Continue the activating flow based on the state of the middle mouse button.

Right Click

Flow

Continue the activating flow based on the state of the right mouse button.

Available nodes:

Node
Description

Get Mouse Button

Branches flows when the mouse buttons are held down.

Get Mouse Button Down

Branches flows in the frame when a mouse buttons is pressed.

Get Mouse Button Up

Branches flows in the frame when a mouse button is released.

Input get nodes

There are multiple nodes that you can use to get input states. The input get nodes have a similar arrangement of inputs and outputs, as described in the following sections.

Inputs:

Name
Type
Description

<varies>

String

The name of the input to evaluate.

Outputs:

Name
Type
Description

[Bool or Float] Out

Boolean or Float

For most nodes, a Boolean output indicates if the input is active. For example, if a key is pressed. For the Get Axis node, the output is a float that indicates the deflection of input thumbstick, trackpad, or similar.

Available nodes:

Name
Description

Get Button Down

Outputs true in the frame where the named button is pressed.

Get Button

Outputs true if the named button is held down.

Get Button Up

Outputs true in the frame where the named button is released.

Get Key Down

Outputs true in the frame where the named key is pressed.

Get Key

Outputs true if the named key is held down.

Get Key Up

Outputs true in the frame where the named key is released.

Get Axis

Outputs the amount of deflection in the named axis.

Input
The available mouse input nodes
Example input get node - the Get Key Up node