Header menu logo Nu

Facet Type

Dynamically augments an entity's behavior in a composable way.

Constructors

Constructor Description

Facet(physical, lightProbe, light)

Full Usage: Facet(physical, lightProbe, light)

Parameters:
    physical : bool
    lightProbe : bool
    light : bool

Returns: Facet
physical : bool
lightProbe : bool
light : bool
Returns: Facet

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

Participate in getting the default size of an entity.

entity : Entity
world : World
Returns: AttributesInferred

this.Light

Full Usage: this.Light

Returns: bool

Whether a facet participates in lighting.

Returns: bool

this.LightProbe

Full Usage: this.LightProbe

Returns: bool

Whether a facet participates in light mapping.

Returns: bool

this.Physical

Full Usage: this.Physical

Returns: bool

Whether a facet participates in a physics system.

Returns: bool

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

Participate in attempting 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 a facet when adding it to an entity.

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 a facet.

renderPass : RenderPass
entity : Entity
world : World

this.Unregister

Full Usage: this.Unregister

Parameters:
Modifiers: abstract

Unregister a facet when removing it from an entity.

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 a facet.

entity : Entity
world : World

Type something to start searching.