Class ParticleDebugBlock
Hierarchy (View Summary)
- NodeParticleBlock
- ParticleDebugBlock
Constructors
constructor
-
Create a new ParticleDebugBlock
Parameters
- name: string
defines the block name
Returns ParticleDebugBlock
- name: string
Properties
comments
A free comment about the block
log
Gets the log entries
on
Gets an observable raised when the block is built
on
Observable raised when data is collected
on
Gets an observable raised when the block is disposed
on
Gets an observable raised when the inputs of the block change
stack
Gets or sets the number of logs to keep
unique
Gets or sets the unique id of the node
visible
Gets or sets a boolean indicating that this input can be edited from a collapsed frame
Accessors
input
-
Gets the input component
Returns NodeParticleConnectionPoint
inputs
-
Gets the list of input points
Returns NodeParticleConnectionPoint[]
is
-
get isDebug(): boolean
Gets a boolean indicating if this block is a debug block
Returns boolean
is
-
get isInput(): boolean
Gets a boolean indicating that this block is an input block
Returns boolean
is
-
get isSystem(): boolean
Gets a boolean indicating that this block is a system block
Returns boolean
is
-
get isTeleportIn(): boolean
Gets a boolean indicating if this block is a teleport in
Returns boolean
is
-
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
output
-
Gets the output component
Returns NodeParticleConnectionPoint
outputs
-
Gets the list of output points
Returns NodeParticleConnectionPoint[]
Methods
_
-
Builds the block. Must be implemented by derived classes.
Parameters
- state: NodeParticleBuildState
Returns void
build
-
Builds the block
Parameters
- state: NodeParticleBuildState
defines the current build state
Returns boolean
the built block
- state: NodeParticleBuildState
clone
-
Clone the current block to a new identical block
Returns NodeParticleBlock | null
a copy of the current block
dispose
-
Release resources
Returns void
get
-
Gets the current class name
Returns string
the class name
get
-
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
- name: string
is
-
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
- block: NodeParticleBlock
is
-
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
- type: string
register
-
registerInput(
name: string,
type: NodeParticleBlockConnectionPointTypes,
isOptional?: boolean,
value?: any,
valueMin?: any,
valueMax?: any,
): ParticleDebugBlockRegister 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: anyvalue to return if there is no connection
OptionalvalueMin: anymin value accepted for value
OptionalvalueMax: anymax value accepted for value
Returns ParticleDebugBlock
the current block
- name: string
register
-
registerOutput(
name: string,
type: NodeParticleBlockConnectionPointTypes,
point?: NodeParticleConnectionPoint,
): ParticleDebugBlockRegister 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: NodeParticleConnectionPointan already created connection point. If not provided, create a new one
Returns ParticleDebugBlock
the current block
- name: string
serialize
-
Serializes this block in a JSON representation
Returns any
the serialized block object
Defines a block used to debug values going through it