Class BoxShapeBlock

comments

onBuildObservable

onDisposeObservable

onInputChangedObservable

uniqueId

visibleOnFrame

inputs

• get inputs(): NodeParticleConnectionPoint[]

  Gets the list of input points

  Returns NodeParticleConnectionPoint[]

isDebug

• get isDebug(): boolean

  Gets a boolean indicating if this block is a debug block

  Returns boolean

isInput

• get isInput(): boolean

  Gets a boolean indicating that this block is an input block

  Returns boolean

isSystem

• get isSystem(): boolean

  Gets a boolean indicating that this block is a system block

  Returns boolean

isTeleportIn

• get isTeleportIn(): boolean

  Gets a boolean indicating if this block is a teleport in

  Returns boolean

isTeleportOut

• get isTeleportOut(): boolean

  Gets a boolean indicating if this block is a teleport out

  Returns boolean

name

• get name(): string

  Gets or set the name of the block

  Returns string

• set name(value: string): void

  Parameters

  • value: string

  Returns void

outputs

• get outputs(): NodeParticleConnectionPoint[]

  Gets the list of output points

  Returns NodeParticleConnectionPoint[]

build

• build(state: NodeParticleBuildState): boolean

  Builds the block

  Parameters

  • state: NodeParticleBuildState

    defines the current build state

  Returns boolean

  the built block

clone

• clone(): NodeParticleBlock | null

  Clone the current block to a new identical block

  Returns NodeParticleBlock | null

  a copy of the current block

dispose

• dispose(): void

  Release resources

  Returns void

getInputByName

• getInputByName(name: string): NodeParticleConnectionPoint | null

  Find an input by its name

  Parameters

  • name: string

    defines the name of the input to look for

  Returns NodeParticleConnectionPoint | null

  the input or null if not found

isAnAncestorOf

• isAnAncestorOf(block: NodeParticleBlock): boolean

  Checks if the current block is an ancestor of a given block

  Parameters

  • block: NodeParticleBlock

    defines the potential descendant block to check

  Returns boolean

  true if block is a descendant

isAnAncestorOfType

• isAnAncestorOfType(type: string): boolean

  Checks if the current block is an ancestor of a given type

  Parameters

  • type: string

    defines the potential type to check

  Returns boolean

  true if block is a descendant

registerInput

• registerInput(
      name: string,
      type: NodeParticleBlockConnectionPointTypes,
      isOptional?: boolean,
      value?: any,
      valueMin?: any,
      valueMax?: any,
  ): BoxShapeBlock

  Register a new input. Must be called inside a block constructor

  Parameters

  • name: string

    defines the connection point name

  • type: NodeParticleBlockConnectionPointTypes

    defines the connection point type

  • isOptional: boolean = false

    defines a boolean indicating that this input can be omitted

  • Optionalvalue: any

    value to return if there is no connection

  • OptionalvalueMin: any

    min value accepted for value

  • OptionalvalueMax: any

    max value accepted for value

  Returns BoxShapeBlock

  the current block

registerOutput

• registerOutput(
      name: string,
      type: NodeParticleBlockConnectionPointTypes,
      point?: NodeParticleConnectionPoint,
  ): BoxShapeBlock

  Register a new output. Must be called inside a block constructor

  Parameters

  • name: string

    defines the connection point name

  • type: NodeParticleBlockConnectionPointTypes

    defines the connection point type

  • Optionalpoint: NodeParticleConnectionPoint

    an already created connection point. If not provided, create a new one

  Returns BoxShapeBlock

  the current block

serialize

• serialize(): any

  Serializes this block in a JSON representation

  Returns any

  the serialized block object