🧰
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
  • List Add
  • List Clear
  • List Contains
  • List Count
  • List Get At Index
  • List Index Of
  • List Insert
  • List Remove At Index
  • List Remove Item
  • List Replace At
  1. AFX
  2. Node dictionary
  3. Variable

List

List Add

Appends an object to the end of a list each time that the flow is activated. The object must be of the same type as the list.

Inputs:

Name
Type
Description

Enter

Flow

Flow to activate the node.

List

List <varies>

The list to add an object to.

Item to Add

<varies>

The object to add to the list.

Outputs:

Name
Type
Description

Exit

Flow

Continue the activating flow.

List Clear

Removes all objects from a list.

Inputs:

Name
Type
Description

Enter

Flow

Flow to activate the node.

List

List <varies>

The list to clear.

Outputs:

Name
Type
Description

Exit

Flow

Continue the activating flow.

List Contains

Tests whether a referenced list contains the specified object.

Inputs:

Name
Type
Description

List

List <varies>

The list to be searched.

Object

<varies>

The object to search for.

Outputs:

Name
Type
Description

Bool Out

Boolean

True if Object is in List. False otherwise.

List Count

Outputs the number of objects in a list.

Inputs:

Name
Type
Description

List

List <varies>

The list to evaluate.

Outputs:

Name
Type
Description

Count

Integer

The number of objects in the list.

List Get At Index

Outputs the object at the given index in a list.

Inputs:

Name
Type
Description

Index

Integer [editable]

The index of the object to retrieve. Lists are zero indexed.

List

List <varies>

The list to retrieve an object from.

Outputs:

Name
Type
Description

Output

<varies>

The object at the given index.

List Index Of

Outputs the index of the given object, or -1 if the object is not in the list.

Inputs:

Name
Type
Description

List

List <varies>

The list to search.

Object

<varies>

The object to search for.

Outputs:

Name
Type
Description

Index

Integer

The index of Object in List, or -1 if Object is not in List.

List Insert

Inserts an object into a list at the given index. The objects at that index and higher are displaced to the next index up. The result is that the length of the list increases by 1.

To replace an object at a given index, see List Replace At. To append to the end of a list, see List Add.

Inputs:

Name
Type
Description

Enter

Flow

Flow to activate the node.

Index

Integer [editable]

The location where the object is to be inserted.

List

List <varies>

The list into which the object will be inserted.

Outputs:

Name
Type
Description

Exit

Flow

Continue the activating flow.

List Remove At Index

Removes an object from a list at the given index. Objects at higher indexes are shifted down. The result is that the length of the list is reduced by 1.

Inputs:

Name
Type
Description

Enter

Flow

Flow to activate the node.

Index

Integer [editable]

The index of the object to remove.

List

List <varies>

The list to remove the object from.

Outputs:

Name
Type
Description

Exit

Flow

Continue the activating flow.

List Remove Item

Remove a matching object from a list. If there are multiple matching objects in the list, the object with the lowest index is removed. If the object is not found, no action is taken.

Inputs:

Name
Type
Description

Enter

Flow

Flow to activate the node.

List

List <varies>

The list from which to remove the object.

Item To Remove

<varies>

The object to remove.

Outputs:

Name
Type
Description

Exit

Flow

Continue the activating flow.

List Replace At

Replaces the object at the given index in a list with the input object.

Inputs:

Name
Type
Description

Enter

Flow

Flow to activate the node.

Index

Integer [editable]

The index of the object to replace.

List

List <varies>

The list in which to replace the object.

Item To Replace

<varies>

The replacement object.

Outputs:

Name
Type
Description

Exit

Flow

Continue the activating flow.

PreviousIntNextMath

Last updated 7 months ago