Class CarbonLogicGraph

The CarbonLogicGraph implements a CarbonGraph that can be used to create logic behaviors that are executed when assigned to a CarbonLogic

Hierarchy (view full)

Constructors

constructor

Properties

_isEnabling comments isValidationCritical nodes userData validationStatus variables viewportPosition viewportZoomScale controlFlowInputPinName controlFlowOutputPinName

Accessors

defaultVariableType handle isDestroyed metaData name uuid variableGetterType variableSetterType

Methods

addComment addCommentWithRegion addConnection addNode addVariable duplicate enable execute executeEvent executeNode executeRoot findNode findNodeWithType findVariable getComment iterateAccessorsForVariable iterateNodesWithType markAsDirty onComponentCarbonEvent onComponentDisable onComponentEnable onComponentFixedUpdate onComponentInput onComponentLateUpdate onComponentTransformChanged onComponentUpdate onComponentVirtualInput onCreate onDeserializationEnded onDisable onEnable onInitialize onSerializationStart removeComment removeConnection removeNode removeOutdatedVariableValues removeVariable renameVariable revert setVariableDefaultValue unload validate

Events

onDirty onDirty onNodeAdded onNodeRemoved onConnectionAdded onConnectionRemoved onVariableAdded onVariableRemoved onVariableChanged onVariableDefaultValueChanged onCommentAdded onCommentRemoved onValidationError onExecutionConnectionVisited onExecutionRootVisited

Constructors

constructor

Properties

Protected_isEnabling

_isEnabling

Readonlycomments

comments: GraphComment[]

All GraphComment objects to display in the editor for this Graph

isValidationCritical

isValidationCritical: boolean

The status of the validation, undefined until validate was called.

Readonlynodes

nodes: GraphNode[]

All GraphNode objects registerded with this graph.

ReadonlyuserData

userData: Map<string, any>

A Map suitable for storing custom user-defined data.

validationStatus

validationStatus: Map<GraphObject, string>

The status of the validation since the last call to validate.

Readonlyvariables

variables: GraphVariable[]

All GraphVariable objects registered with this graph.

ReadonlyviewportPosition

viewportPosition: Vector2

Determines the panning position of the user has last moved the graph canvas to.

viewportZoomScale

viewportZoomScale: number

Determines the zoom scale of the user has the graph canvas at.

Static ReadonlycontrolFlowInputPinName

controlFlowInputPinName = "CF[In]"

Static ReadonlycontrolFlowOutputPinName

controlFlowOutputPinName = "CF[Out]"

Accessors

defaultVariableType

  • get defaultVariableType(): Type
  • Virtual

    Gets the default type of a newly constructed empty variable.

    Returns Type

handle

isDestroyed

  • get isDestroyed(): boolean

  • Determines if the resource is destroyed.

    Returns boolean

    Note

    This can happen when the Resource was forcefully unloaded or reverted. For this reason, it is safer to hold on to a instead of directly referencing a resource pointer, as the current Resource can always be retrieved via .value.

metaData

name

  • get name(): string

  • Name of the resource. Use primarily for easier identification and not important to the engine itself.

    Returns string

uuid

  • get uuid(): UUID

  • Returns a universally unique identifier of this resource.

    Returns UUID

variableGetterType

variableSetterType

Methods

addComment

addCommentWithRegion

  • addCommentWithRegion(region, title, description?): GraphComment

  • Adds a new comment to the graph.

    Parameters

    • region: Immutable<Rect2>

      The region to create the new comment on, including the origin and it's size.

    • title: string

      A string that represents the title for the comment.

    • Optionaldescription: string

      A string that represents a description for the comment.

    Returns GraphComment

    The newly created commented object.

addConnection

  • addConnection(connectionOrPins): void

  • Adds the specified GraphConnection.

    Parameters

    Returns void

    Note

    The connection will be registered with both the input and output GraphPin. Before the connection is registered onFilterAddConnection will be invoked to allow the graph to dynamically replace the connection.

addNode

addVariable

  • addVariable(variable): boolean

  • Adds the specified GraphVariable.

    Parameters

    Returns boolean

    true if the variable was added, false on error.

    Note

    If a variable with the same name already exists, a suffix will be appened.

duplicate

  • duplicate(): Resource

  • Duplicates the resource and creates a unique UUID for the duplicated resource.

    Returns Resource

    The duplicated resource or null, if the duplication failed.

Protectedenable

  • enable(): void

  • Invoken when the graph was deserialized and objects need to be enabled. This typically entails restoring object pointers that cannot be serialized.

    Returns void

execute

executeEvent

  • executeEvent<T>(type, component, data?): void

  • Executes the CarbonLogicEventNode of the specified type.

    Type Parameters

    Parameters

    • type: ClassOf<T>

      The type to execute.

    • component: CarbonLogic

      A reference to the component that triggered the event.

    • Optionaldata: CarbonLogicData

      The optional execution data.

    Returns void

executeNode

executeRoot

  • executeRoot(rootOrConnection, controlFlowData): void

  • Executes the specified root node in the graph with the controlFlowData.

    Parameters

    • rootOrConnection: GraphConnection | ControlFlowNodeBase

      The root node to execution or a connection to execute as root. When a ControlFlowNodeBase is specified, the node is immediately executed as the first node. When a GraphConnection is specified, the node that is connected to the connections input pin is executed as the first node.

    • controlFlowData: ControlFlowData

      The control flow data for the current execution.

    Returns void

    Note

    Each call to executeNode returns the next connection to be executed. The execution will run until null is returned.

findNode

findNodeWithType

findVariable

getComment

iterateAccessorsForVariable

iterateNodesWithType

markAsDirty

onComponentCarbonEvent

  • onComponentCarbonEvent(component, animation, eventName, object): void

  • Executes the CarbonLogicOnCarbonEvent event node.

    Parameters

    • component: CarbonLogic

      A reference to the component that triggered the event.

    • animation: Component
    • eventName: string
    • object: any

    Returns void

onComponentDisable

  • onComponentDisable(component): void

  • Executes the CarbonLogicOnDisable event node.

    Parameters

    • component: CarbonLogic

      A reference to the component that triggered the event.

    Returns void

onComponentEnable

  • onComponentEnable(component): void

  • Executes the CarbonLogicOnEnable event node.

    Parameters

    • component: CarbonLogic

      A reference to the component that triggered the event.

    Returns void

onComponentFixedUpdate

  • onComponentFixedUpdate(component): void

  • Executes the CarbonLogicOnFixedUpdate event node.

    Parameters

    • component: CarbonLogic

      A reference to the component that triggered the event.

    Returns void

onComponentInput

  • onComponentInput(component, event, isDown): void

  • Executes the CarbonLogicOnInput event node.

    Parameters

    • component: CarbonLogic

      A reference to the component that triggered the event.

    • event: ButtonEvent
    • isDown: boolean

    Returns void

onComponentLateUpdate

  • onComponentLateUpdate(component): void

  • Executes the CarbonLogicOnLateUpdate event node.

    Parameters

    • component: CarbonLogic

      A reference to the component that triggered the event.

    Returns void

onComponentTransformChanged

  • onComponentTransformChanged(component): void

  • Executes the CarbonLogicOnTransformChanged event node.

    Parameters

    • component: CarbonLogic

      A reference to the component that triggered the event.

    Returns void

onComponentUpdate

  • onComponentUpdate(component): void

  • Executes the CarbonLogicOnUpdate event node.

    Parameters

    • component: CarbonLogic

      A reference to the component that triggered the event.

    Returns void

onComponentVirtualInput

  • onComponentVirtualInput(component, button, deviceIndex, isDown, isHeld): void

  • Executes the CarbonLogicOnVirtualInput event node.

    Parameters

    • component: CarbonLogic

      A reference to the component that triggered the event.

    • button: VirtualButton
    • deviceIndex: number
    • isDown: boolean
    • isHeld: boolean

    Returns void

onCreate

  • onCreate(this): void
  • Virtual

    Method called by RSX to perform actions required after the creation of the resource.

    Parameters

    Returns void

onDeserializationEnded

  • onDeserializationEnded(): void
  • Virtual

    Method called by RSX to perform any operations needed after deserialization.

    Returns void

    Note

    Use this API to restore your serializable data into live objects.

onDisable

  • onDisable(): void
  • Virtual

    Method called by RSX to disable the resource.

    Returns void

    Note

    Use this API to deactivate the resource before it is serialized.

onEnable

  • onEnable(): void
  • Virtual

    Method called by RSX to enable the resource.

    Returns void

    Note

    Use this API to activate the resource after it has been disabled by serialization.

onInitialize

  • onInitialize(this): void
  • Virtual

    Method called by RSX to perform initialization of the resource.

    Parameters

    Returns void

    Note

    Use this API to initialize data and default construct all fields.

onSerializationStart

  • onSerializationStart(): void
  • Virtual

    Method called by RSX to perform any operations before serialization.

    Returns void

    Note

    Use this API to bake your live data into serializable data.

removeComment

removeConnection

removeNode

removeOutdatedVariableValues

  • removeOutdatedVariableValues(variableValues): void

  • Removes all persisted GraphVariable data from variableValues that have been removed or are no longer public.

    Parameters

    • variableValues: Map<bigint, any>

      The persistent variable values that will be modified.

    Returns void

removeVariable

renameVariable

revert

  • revert(): boolean

  • Reverts the resource to the on-disk representation.

    Returns boolean

    Note

    This is a potentially expensive call, as it needs to deserialize and replace all existing in-memory resource handles.

setVariableDefaultValue

unload

  • unload(): void

  • Forcefully unloads the resource.

    Returns void

validate

  • validate(): void
  • Virtual

    Ensures that the state of the graph is valid.

    Returns void

    Note

    Implementing classes must call super. The method is typically called after deserialization or major edits to the graph. If validation fails, error information must be added to the validationStatus map.

Events

ReadonlyonDirty

onDirty: Event<[GraphObject | Graph, EnumValue<GraphNodeDirtyFlags, number>], void>

An event called when a change on the graph was made.

ReadonlyonDirty

onDirty: Event<[GraphObject | Graph, EnumValue<GraphNodeDirtyFlags, number>], void>

An event called when a change on the graph was made.

ReadonlyonNodeAdded

onNodeAdded: Event<[GraphNode], void>

An event called whenever a new GraphNode is added.

ReadonlyonNodeRemoved

onNodeRemoved: Event<[GraphNode], void>

An event called whenever a GraphNode is removed.

ReadonlyonConnectionAdded

onConnectionAdded: Event<[GraphConnection], void>

An event called whenever a new connection was made.

ReadonlyonConnectionRemoved

onConnectionRemoved: Event<[GraphConnection], void>

An event called whenever a connection is removed.

ReadonlyonVariableAdded

onVariableAdded: Event<[GraphVariable], void>

An event called whenever a new GraphVariable is added.

ReadonlyonVariableRemoved

onVariableRemoved: Event<[GraphVariable], void>

An event called whenever a new GraphVariable was removed.

ReadonlyonVariableChanged

onVariableChanged: Event<[GraphVariable], void>

An event called whenever a new GraphVariable was changed, e.g. name, type or meta-data.

ReadonlyonVariableDefaultValueChanged

onVariableDefaultValueChanged: Event<[GraphVariable], void>

An event called whenever a new GraphVariable was default value changed.

ReadonlyonCommentAdded

onCommentAdded: Event<[GraphComment], void>

An event called whenever a new GraphComment is added.

ReadonlyonCommentRemoved

onCommentRemoved: Event<[GraphComment], void>

An event called whenever a new GraphComment was removed.

ReadonlyonValidationError

onValidationError: Event<[Map<GraphObject, string>], void>

An event called whenever validation resulted in errors.

ReadonlyonExecutionConnectionVisited

onExecutionConnectionVisited: Event<[GraphConnection, GraphExecutionState], void>

An event called whenever a connection was visited by the execution.

Editor Only

ReadonlyonExecutionRootVisited

onExecutionRootVisited: Event<[GraphNode, GraphExecutionState], void>

An event called whenever a root node was visited by the execution.

Editor Only

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
Events