Header menu logo Nu

EntityDispatcher Type

The default dispatcher for entities.

Constructors

Constructor Description

EntityDispatcher(is2d, physical, lightProbe, light)

Full Usage: EntityDispatcher(is2d, physical, lightProbe, light)

Parameters:
    is2d : bool
    physical : bool
    lightProbe : bool
    light : bool

Returns: EntityDispatcher
is2d : bool
physical : bool
lightProbe : bool
light : bool
Returns: EntityDispatcher

Instance members

Instance member Description

this.Edit

Full Usage: this.Edit

Parameters:
Modifiers: abstract

Participate in defining additional editing behavior for an entity via the ImGui API.

op : EditOperation
entity : Entity
world : World

this.GetAttributesInferred

Full Usage: this.GetAttributesInferred

Parameters:
Returns: AttributesInferred
Modifiers: abstract

Get the default size of an entity.

entity : Entity
world : World
Returns: AttributesInferred

this.Is2d

Full Usage: this.Is2d

Returns: bool

Whether the dispatcher has a 2-dimensional transform interpretation.

Returns: bool

this.Is3d

Full Usage: this.Is3d

Returns: bool

Whether the dispatcher has a 3-dimensional transform interpretation.

Returns: bool

this.Light

Full Usage: this.Light

Returns: bool

Whether the dispatcher participates directly in lighting (not counting its facets).

Returns: bool

this.LightProbe

Full Usage: this.LightProbe

Returns: bool

Whether the dispatcher participates directly in light mapping (not counting its facets).

Returns: bool

this.Physical

Full Usage: this.Physical

Returns: bool

Whether the dispatcher participates directly in a physics system (not counting its facets).

Returns: bool

this.Physics

Full Usage: this.Physics

Parameters:
Modifiers: abstract

Apply physics changes from a physics engine to an entity.

center : Vector3
rotation : Quaternion
linearVelocity : Vector3
angularVelocity : Vector3
entity : Entity
world : World

this.PresenceOverride

Full Usage: this.PresenceOverride

Returns: Presence voption
Modifiers: abstract

The presence override, if any.

Returns: Presence voption

this.RayCast

Full Usage: this.RayCast

Parameters:
Returns: Intersection array
Modifiers: abstract

Attempt to pick an entity with a ray.

ray : Ray3
entity : Entity
world : World
Returns: Intersection array

this.Register

Full Usage: this.Register

Parameters:
Modifiers: abstract

Register an entity when adding it to a group.

entity : Entity
world : World

this.RegisterPhysics

Full Usage: this.RegisterPhysics

Parameters:
Modifiers: abstract

Participate in the registration of an entity's physics with the physics subsystems.

entity : Entity
world : World

this.Render

Full Usage: this.Render

Parameters:
Modifiers: abstract

Render an entity.

renderPass : RenderPass
entity : Entity
world : World

this.Signal

Full Usage: this.Signal

Parameters:
Modifiers: abstract

Send a signal to an entity.

signalObj : obj
entity : Entity
world : World

this.TryGetFallbackModel

Full Usage: this.TryGetFallbackModel

Parameters:
Returns: 'a option
Modifiers: abstract
Type parameters: 'a

Attempt to get the fallback model value if the dispatcher defines one.

modelSymbol : Symbol
entity : Entity
world : World
Returns: 'a option

this.TryProcess

Full Usage: this.TryProcess

Parameters:
Modifiers: abstract

Attempt to ImSim process an entity.

zeroDelta : bool
entity : Entity
world : World

this.TrySynchronize

Full Usage: this.TrySynchronize

Parameters:
Modifiers: abstract

Attempt to synchronize content of an entity.

initializing : bool
entity : Entity
world : World

this.TryTruncateModel

Full Usage: this.TryTruncateModel

Parameters:
    model : 'a

Returns: 'a option
Modifiers: abstract
Type parameters: 'a

Attempt to truncate an entity model.

model : 'a
Returns: 'a option

this.TryUntruncateModel

Full Usage: this.TryUntruncateModel

Parameters:
Returns: 'a option
Modifiers: abstract
Type parameters: 'a

Attempt to untruncate an entity model.

model : 'a
Entity : Entity
world : World
Returns: 'a option

this.Unregister

Full Usage: this.Unregister

Parameters:
Modifiers: abstract

Unregister an entity when removing it from a group.

entity : Entity
world : World

this.UnregisterPhysics

Full Usage: this.UnregisterPhysics

Parameters:
Modifiers: abstract

Participate in the unregistration of an entity's physics from the physics subsystems.

entity : Entity
world : World

this.Update

Full Usage: this.Update

Parameters:
Modifiers: abstract

Update an entity.

entity : Entity
world : World

Static members

Static member Description

EntityDispatcher.Properties

Full Usage: EntityDispatcher.Properties

Returns: PropertyDefinition list
Returns: PropertyDefinition list

Type something to start searching.