Header menu logo Nu

WorldEntityModule Module

Entity functions for the world (2/2).

Type extensions

Type extension Description

this.Absolute

Full Usage: this.Absolute

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.Absolute

Full Usage: this.Absolute

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.AffineMatrix

Full Usage: this.AffineMatrix

Parameters:
    () : unit

Returns: Lens<Matrix4x4, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Matrix4x4, Entity>

this.AffineMatrix

Full Usage: this.AffineMatrix

Returns: Lens<Matrix4x4, Entity>

Extended Type: Entity

Returns: Lens<Matrix4x4, Entity>

this.AffineMatrixLocal

Full Usage: this.AffineMatrixLocal

Parameters:
    () : unit

Returns: Lens<Matrix4x4, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Matrix4x4, Entity>

this.AffineMatrixLocal

Full Usage: this.AffineMatrixLocal

Returns: Lens<Matrix4x4, Entity>

Extended Type: Entity

Returns: Lens<Matrix4x4, Entity>

this.AlwaysRender

Full Usage: this.AlwaysRender

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.AlwaysRender

Full Usage: this.AlwaysRender

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.AlwaysUpdate

Full Usage: this.AlwaysUpdate

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.AlwaysUpdate

Full Usage: this.AlwaysUpdate

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.Angles

Full Usage: this.Angles

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.Angles

Full Usage: this.Angles

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.AnglesLocal

Full Usage: this.AnglesLocal

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.AnglesLocal

Full Usage: this.AnglesLocal

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.AutoBounds

Full Usage: this.AutoBounds

Parameters:

Automatically change an entity's bounds using its inferred attributes.

Extended Type: Entity

world : World

this.BodyPenetrationEvent

Full Usage: this.BodyPenetrationEvent

Parameters:
    () : unit

Returns: BodyPenetrationData Address

Extended Type: Entity

() : unit
Returns: BodyPenetrationData Address

this.BodyPenetrationEvent

Full Usage: this.BodyPenetrationEvent

Returns: BodyPenetrationData Address

Extended Type: Entity

Returns: BodyPenetrationData Address

this.BodySeparationExplicitEvent

Full Usage: this.BodySeparationExplicitEvent

Parameters:
    () : unit

Returns: BodySeparationExplicitData Address

Extended Type: Entity

() : unit
Returns: BodySeparationExplicitData Address

this.BodySeparationExplicitEvent

Full Usage: this.BodySeparationExplicitEvent

Returns: BodySeparationExplicitData Address

Extended Type: Entity

Returns: BodySeparationExplicitData Address

this.BodySeparationImplicitEvent

Full Usage: this.BodySeparationImplicitEvent

Parameters:
    () : unit

Returns: BodySeparationImplicitData Address

Extended Type: Entity

() : unit
Returns: BodySeparationImplicitData Address

this.BodySeparationImplicitEvent

Full Usage: this.BodySeparationImplicitEvent

Returns: BodySeparationImplicitData Address

Extended Type: Entity

Returns: BodySeparationImplicitData Address

this.BodyTransformEvent

Full Usage: this.BodyTransformEvent

Parameters:
    () : unit

Returns: BodyTransformData Address

Extended Type: Entity

() : unit
Returns: BodyTransformData Address

this.BodyTransformEvent

Full Usage: this.BodyTransformEvent

Returns: BodyTransformData Address

Extended Type: Entity

Returns: BodyTransformData Address

this.Bounds

Full Usage: this.Bounds

Parameters:
    () : unit

Returns: Lens<Box3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Box3, Entity>

this.Bounds

Full Usage: this.Bounds

Returns: Lens<Box3, Entity>

Extended Type: Entity

Returns: Lens<Box3, Entity>

this.CastShadow

Full Usage: this.CastShadow

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.CastShadow

Full Usage: this.CastShadow

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.ChangeEvent

Full Usage: this.ChangeEvent

Parameters:
    propertyName : string

Returns: ChangeData Address

Extended Type: Entity

propertyName : string
Returns: ChangeData Address

this.Degrees

Full Usage: this.Degrees

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.Degrees

Full Usage: this.Degrees

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.DegreesLocal

Full Usage: this.DegreesLocal

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.DegreesLocal

Full Usage: this.DegreesLocal

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.Destroying

Full Usage: this.Destroying

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.Destroying

Full Usage: this.Destroying

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.Dispatcher

Full Usage: this.Dispatcher

Parameters:
    () : unit

Returns: Lens<EntityDispatcher, Entity>

Extended Type: Entity

() : unit
Returns: Lens<EntityDispatcher, Entity>

this.Dispatcher

Full Usage: this.Dispatcher

Returns: Lens<EntityDispatcher, Entity>

Extended Type: Entity

Returns: Lens<EntityDispatcher, Entity>

this.Elevation

Full Usage: this.Elevation

Parameters:
    () : unit

Returns: Lens<single, Entity>

Extended Type: Entity

() : unit
Returns: Lens<single, Entity>

this.Elevation

Full Usage: this.Elevation

Returns: Lens<single, Entity>

Extended Type: Entity

Returns: Lens<single, Entity>

this.ElevationLocal

Full Usage: this.ElevationLocal

Parameters:
    () : unit

Returns: Lens<single, Entity>

Extended Type: Entity

() : unit
Returns: Lens<single, Entity>

this.ElevationLocal

Full Usage: this.ElevationLocal

Returns: Lens<single, Entity>

Extended Type: Entity

Returns: Lens<single, Entity>

this.Enabled

Full Usage: this.Enabled

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.Enabled

Full Usage: this.Enabled

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.EnabledLocal

Full Usage: this.EnabledLocal

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.EnabledLocal

Full Usage: this.EnabledLocal

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.FacetNames

Full Usage: this.FacetNames

Parameters:
    () : unit

Returns: Lens<Set<string>, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Set<string>, Entity>

this.FacetNames

Full Usage: this.FacetNames

Returns: Lens<Set<string>, Entity>

Extended Type: Entity

Returns: Lens<Set<string>, Entity>

this.Facets

Full Usage: this.Facets

Parameters:
    () : unit

Returns: Lens<Facet array, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Facet array, Entity>

this.Facets

Full Usage: this.Facets

Returns: Lens<Facet array, Entity>

Extended Type: Entity

Returns: Lens<Facet array, Entity>

this.Get

Full Usage: this.Get

Parameters:
    propertyName : string
    world : World

Returns: 'a

Get an xtension property value.

Extended Type: Entity

propertyName : string
world : World
Returns: 'a

this.GetAbsolute

Full Usage: this.GetAbsolute

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetAffineMatrix

Full Usage: this.GetAffineMatrix

Parameters:
Returns: Matrix4x4

Extended Type: Entity

world : World
Returns: Matrix4x4

this.GetAffineMatrixLocal

Full Usage: this.GetAffineMatrixLocal

Parameters:
Returns: Matrix4x4

Extended Type: Entity

world : World
Returns: Matrix4x4

this.GetAlwaysRender

Full Usage: this.GetAlwaysRender

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetAlwaysUpdate

Full Usage: this.GetAlwaysUpdate

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetAngles

Full Usage: this.GetAngles

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetAnglesLocal

Full Usage: this.GetAnglesLocal

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetAttributesInferred

Full Usage: this.GetAttributesInferred

Parameters:
Returns: AttributesInferred

Get an entity's inferred attributes.

Extended Type: Entity

world : World
Returns: AttributesInferred

this.GetBounds

Full Usage: this.GetBounds

Parameters:
Returns: Box3

Extended Type: Entity

world : World
Returns: Box3

this.GetCastShadow

Full Usage: this.GetCastShadow

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetChildren

Full Usage: this.GetChildren

Parameters:
Returns: Entity seq

Get an entity's children.

Extended Type: Entity

world : World
Returns: Entity seq

this.GetDegrees

Full Usage: this.GetDegrees

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetDegreesLocal

Full Usage: this.GetDegreesLocal

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetDescendants

Full Usage: this.GetDescendants

Parameters:
Returns: Entity seq

Get an entity's descendants.

Extended Type: Entity

world : World
Returns: Entity seq

this.GetDestroying

Full Usage: this.GetDestroying

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetDispatcher

Full Usage: this.GetDispatcher

Parameters:
Returns: EntityDispatcher

Extended Type: Entity

world : World
Returns: EntityDispatcher

this.GetElevation

Full Usage: this.GetElevation

Parameters:
Returns: single

Extended Type: Entity

world : World
Returns: single

this.GetElevationLocal

Full Usage: this.GetElevationLocal

Parameters:
Returns: single

Extended Type: Entity

world : World
Returns: single

this.GetEnabled

Full Usage: this.GetEnabled

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetEnabledLocal

Full Usage: this.GetEnabledLocal

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetExists

Full Usage: this.GetExists

Parameters:
Returns: bool

Check that an entity exists in the world.

Extended Type: Entity

world : World
Returns: bool

this.GetFacetNames

Full Usage: this.GetFacetNames

Parameters:
Returns: Set<string>

Extended Type: Entity

world : World
Returns: Set<string>

this.GetFacets

Full Usage: this.GetFacets

Parameters:
Returns: Facet array

Extended Type: Entity

world : World
Returns: Facet array

this.GetId

Full Usage: this.GetId

Parameters:
Returns: uint64

Extended Type: Entity

world : World
Returns: uint64

this.GetInPlay2dAbsolute

Full Usage: this.GetInPlay2dAbsolute

Parameters:
Returns: bool

Check that an entity is in the play area irrespective of eye center.

Extended Type: Entity

world : World
Returns: bool

this.GetInPlay2dRelative

Full Usage: this.GetInPlay2dRelative

Parameters:
Returns: bool

Check that an entity is in the play area relative to eye center.

Extended Type: Entity

world : World
Returns: bool

this.GetInView2dAbsolute

Full Usage: this.GetInView2dAbsolute

Parameters:
Returns: bool

Check that an entity is in view irrespective of eye center.

Extended Type: Entity

world : World
Returns: bool

this.GetInView2dRelative

Full Usage: this.GetInView2dRelative

Parameters:
Returns: bool

Check that an entity is in relative to eye center.

Extended Type: Entity

world : World
Returns: bool

this.GetInView3d

Full Usage: this.GetInView3d

Parameters:
Returns: bool

Check that an entity is in the eye's view.

Extended Type: Entity

world : World
Returns: bool

this.GetIs2d

Full Usage: this.GetIs2d

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetIs3d

Full Usage: this.GetIs3d

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetLight

Full Usage: this.GetLight

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetLightProbe

Full Usage: this.GetLightProbe

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetModelGeneric

Full Usage: this.GetModelGeneric

Parameters:
Returns: 'a

Extended Type: Entity

world : World
Returns: 'a

this.GetMountOpt

Full Usage: this.GetMountOpt

Parameters:
Returns: Entity Relation option

Extended Type: Entity

world : World
Returns: Entity Relation option

this.GetMounted

Full Usage: this.GetMounted

Parameters:
Returns: bool

Check that this entity is mounted by another entity.

Extended Type: Entity

world : World
Returns: bool

this.GetMounters

Full Usage: this.GetMounters

Parameters:
Returns: Entity seq

Get an entity's mounters.

Extended Type: Entity

world : World
Returns: Entity seq

this.GetOffset

Full Usage: this.GetOffset

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetOrder

Full Usage: this.GetOrder

Parameters:
Returns: int64

Extended Type: Entity

world : World
Returns: int64

this.GetOverflow

Full Usage: this.GetOverflow

Parameters:
Returns: single

Extended Type: Entity

world : World
Returns: single

this.GetOverlayNameOpt

Full Usage: this.GetOverlayNameOpt

Parameters:
Returns: string option

Extended Type: Entity

world : World
Returns: string option

this.GetPerimeter

Full Usage: this.GetPerimeter

Parameters:
Returns: Box3

Extended Type: Entity

world : World
Returns: Box3

this.GetPerimeterBottom

Full Usage: this.GetPerimeterBottom

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetPerimeterBottomLeft

Full Usage: this.GetPerimeterBottomLeft

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetPerimeterBottomLeftLocal

Full Usage: this.GetPerimeterBottomLeftLocal

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetPerimeterBottomLocal

Full Usage: this.GetPerimeterBottomLocal

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetPerimeterCenter

Full Usage: this.GetPerimeterCenter

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetPerimeterCenterLocal

Full Usage: this.GetPerimeterCenterLocal

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetPerimeterMax

Full Usage: this.GetPerimeterMax

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetPerimeterMaxLocal

Full Usage: this.GetPerimeterMaxLocal

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetPerimeterMin

Full Usage: this.GetPerimeterMin

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetPerimeterMinLocal

Full Usage: this.GetPerimeterMinLocal

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetPerimeterUnscaled

Full Usage: this.GetPerimeterUnscaled

Parameters:
Returns: Box3

Extended Type: Entity

world : World
Returns: Box3

this.GetPersistent

Full Usage: this.GetPersistent

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetPhysical

Full Usage: this.GetPhysical

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetPickable

Full Usage: this.GetPickable

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetPosition

Full Usage: this.GetPosition

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetPositionLocal

Full Usage: this.GetPositionLocal

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetPresence

Full Usage: this.GetPresence

Parameters:
Returns: Presence

Extended Type: Entity

world : World
Returns: Presence

this.GetPresenceOverride

Full Usage: this.GetPresenceOverride

Parameters:
Returns: Presence voption

Get the optional presence override.

Extended Type: Entity

world : World
Returns: Presence voption

this.GetPropagatedDescriptorOpt

Full Usage: this.GetPropagatedDescriptorOpt

Parameters:
Returns: EntityDescriptor option

Extended Type: Entity

world : World
Returns: EntityDescriptor option

this.GetPropagationSourceOpt

Full Usage: this.GetPropagationSourceOpt

Parameters:
Returns: Entity option

Extended Type: Entity

world : World
Returns: Entity option

this.GetPropagationTargets

Full Usage: this.GetPropagationTargets

Parameters:
Returns: Entity seq

Find all the entities to which an entity may propagate its structure.

Extended Type: Entity

world : World
Returns: Entity seq

this.GetProperty

Full Usage: this.GetProperty

Parameters:
    propertyName : string
    world : World

Returns: Property

Get a property value and type.

Extended Type: Entity

propertyName : string
world : World
Returns: Property

this.GetProtected

Full Usage: this.GetProtected

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetRotation

Full Usage: this.GetRotation

Parameters:
Returns: Quaternion

Extended Type: Entity

world : World
Returns: Quaternion

this.GetRotationLocal

Full Usage: this.GetRotationLocal

Parameters:
Returns: Quaternion

Extended Type: Entity

world : World
Returns: Quaternion

this.GetScale

Full Usage: this.GetScale

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetScaleLocal

Full Usage: this.GetScaleLocal

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetSelected

Full Usage: this.GetSelected

Parameters:
Returns: bool

Check that an entity is selected.

Extended Type: Entity

world : World
Returns: bool

this.GetSize

Full Usage: this.GetSize

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetSortingPriority2d

Full Usage: this.GetSortingPriority2d

Parameters:
Returns: SortPriority

Get an entity's sorting priority in 2d.

Extended Type: Entity

world : World
Returns: SortPriority

this.GetStatic

Full Usage: this.GetStatic

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetTransform

Full Usage: this.GetTransform

Parameters:
Returns: Transform

Extended Type: Entity

world : World
Returns: Transform

this.GetVisible

Full Usage: this.GetVisible

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetVisibleLocal

Full Usage: this.GetVisibleLocal

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.Has

Full Usage: this.Has

Parameters:
Returns: bool

Check that an entity uses a facet of the given type.

Extended Type: Entity

facetType : Type
world : World
Returns: bool

this.Has

Full Usage: this.Has

Parameters:
Returns: bool

Check that an entity uses a facet of the given type.

Extended Type: Entity

world : World
Returns: bool

this.HasChildren

Full Usage: this.HasChildren

Parameters:
Returns: bool

Check that an entity has children.

Extended Type: Entity

world : World
Returns: bool

this.HasMountee

Full Usage: this.HasMountee

Parameters:
Returns: bool

Check that this entity is mounted on another entity.

Extended Type: Entity

world : World
Returns: bool

this.HasMounters

Full Usage: this.HasMounters

Parameters:
Returns: bool

Check than an entity has any other entitiese mounted on it.

Extended Type: Entity

world : World
Returns: bool

this.HasPropagationTargets

Full Usage: this.HasPropagationTargets

Parameters:
Returns: bool

Check that entity has entities to propagate its structure to.

Extended Type: Entity

world : World
Returns: bool

this.Id

Full Usage: this.Id

Parameters:
    () : unit

Returns: Lens<uint64, Entity>

Extended Type: Entity

() : unit
Returns: Lens<uint64, Entity>

this.Id

Full Usage: this.Id

Returns: Lens<uint64, Entity>

Extended Type: Entity

Returns: Lens<uint64, Entity>

this.Is

Full Usage: this.Is

Parameters:
Returns: bool

Check that an entity dispatches in the same manner as the dispatcher with the given type.

Extended Type: Entity

dispatcherType : Type
world : World
Returns: bool

this.Is

Full Usage: this.Is

Parameters:
Returns: bool

Check that an entity dispatches in the same manner as the dispatcher with the given type.

Extended Type: Entity

world : World
Returns: bool

this.Is2d

Full Usage: this.Is2d

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.Is2d

Full Usage: this.Is2d

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.Is3d

Full Usage: this.Is3d

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.Is3d

Full Usage: this.Is3d

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.IsMounter

Full Usage: this.IsMounter

Parameters:
Returns: bool

Check that this entity is mounted on another entity.

Extended Type: Entity

world : World
Returns: bool

this.Light

Full Usage: this.Light

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.Light

Full Usage: this.Light

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.LightProbe

Full Usage: this.LightProbe

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.LightProbe

Full Usage: this.LightProbe

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.ModelGeneric

Full Usage: this.ModelGeneric

Parameters:
    () : unit

Returns: Lens<'a, Entity>

Extended Type: Entity

() : unit
Returns: Lens<'a, Entity>

this.MountEvent

Full Usage: this.MountEvent

Parameters:
    () : unit

Returns: MountData Address

Extended Type: Entity

() : unit
Returns: MountData Address

this.MountEvent

Full Usage: this.MountEvent

Returns: MountData Address

Extended Type: Entity

Returns: MountData Address

this.MountExists

Full Usage: this.MountExists

Parameters:
Returns: bool

Check whether the entity's mount exists.

Extended Type: Entity

world : World
Returns: bool

this.MountOpt

Full Usage: this.MountOpt

Parameters:
    () : unit

Returns: Lens<Entity Relation option, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Entity Relation option, Entity>

this.MountOpt

Full Usage: this.MountOpt

Returns: Lens<Entity Relation option, Entity>

Extended Type: Entity

Returns: Lens<Entity Relation option, Entity>

this.NotifyModelChange

Full Usage: this.NotifyModelChange

Parameters:

Notify the engine that an entity's MMCC model has changed in some automatically undetectable way (such as being mutated directly by user code).

Extended Type: Entity

world : World

this.Offset

Full Usage: this.Offset

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.Offset

Full Usage: this.Offset

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.Order

Full Usage: this.Order

Parameters:
    () : unit

Returns: Lens<int64, Entity>

Extended Type: Entity

() : unit
Returns: Lens<int64, Entity>

this.Order

Full Usage: this.Order

Returns: Lens<int64, Entity>

Extended Type: Entity

Returns: Lens<int64, Entity>

this.Overflow

Full Usage: this.Overflow

Parameters:
    () : unit

Returns: Lens<single, Entity>

Extended Type: Entity

() : unit
Returns: Lens<single, Entity>

this.Overflow

Full Usage: this.Overflow

Returns: Lens<single, Entity>

Extended Type: Entity

Returns: Lens<single, Entity>

this.OverlayNameOpt

Full Usage: this.OverlayNameOpt

Parameters:
    () : unit

Returns: Lens<string option, Entity>

Extended Type: Entity

() : unit
Returns: Lens<string option, Entity>

this.OverlayNameOpt

Full Usage: this.OverlayNameOpt

Returns: Lens<string option, Entity>

Extended Type: Entity

Returns: Lens<string option, Entity>

this.Perimeter

Full Usage: this.Perimeter

Parameters:
    () : unit

Returns: Lens<Box3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Box3, Entity>

this.Perimeter

Full Usage: this.Perimeter

Returns: Lens<Box3, Entity>

Extended Type: Entity

Returns: Lens<Box3, Entity>

this.PerimeterBottom

Full Usage: this.PerimeterBottom

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.PerimeterBottom

Full Usage: this.PerimeterBottom

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.PerimeterBottomLeft

Full Usage: this.PerimeterBottomLeft

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.PerimeterBottomLeft

Full Usage: this.PerimeterBottomLeft

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.PerimeterBottomLeftLocal

Full Usage: this.PerimeterBottomLeftLocal

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.PerimeterBottomLeftLocal

Full Usage: this.PerimeterBottomLeftLocal

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.PerimeterBottomLocal

Full Usage: this.PerimeterBottomLocal

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.PerimeterBottomLocal

Full Usage: this.PerimeterBottomLocal

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.PerimeterCenter

Full Usage: this.PerimeterCenter

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.PerimeterCenter

Full Usage: this.PerimeterCenter

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.PerimeterCenterLocal

Full Usage: this.PerimeterCenterLocal

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.PerimeterCenterLocal

Full Usage: this.PerimeterCenterLocal

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.PerimeterMax

Full Usage: this.PerimeterMax

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.PerimeterMax

Full Usage: this.PerimeterMax

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.PerimeterMaxLocal

Full Usage: this.PerimeterMaxLocal

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.PerimeterMaxLocal

Full Usage: this.PerimeterMaxLocal

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.PerimeterMin

Full Usage: this.PerimeterMin

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.PerimeterMin

Full Usage: this.PerimeterMin

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.PerimeterMinLocal

Full Usage: this.PerimeterMinLocal

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.PerimeterMinLocal

Full Usage: this.PerimeterMinLocal

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.PerimeterUnscaled

Full Usage: this.PerimeterUnscaled

Parameters:
    () : unit

Returns: Lens<Box3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Box3, Entity>

this.PerimeterUnscaled

Full Usage: this.PerimeterUnscaled

Returns: Lens<Box3, Entity>

Extended Type: Entity

Returns: Lens<Box3, Entity>

this.Persistent

Full Usage: this.Persistent

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.Persistent

Full Usage: this.Persistent

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.Physical

Full Usage: this.Physical

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.Physical

Full Usage: this.Physical

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.Physics

Full Usage: this.Physics

Parameters:

Apply physics changes to an entity.

Extended Type: Entity

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

this.Pickable

Full Usage: this.Pickable

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.Pickable

Full Usage: this.Pickable

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.Position

Full Usage: this.Position

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.Position

Full Usage: this.Position

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.PositionLocal

Full Usage: this.PositionLocal

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.PositionLocal

Full Usage: this.PositionLocal

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.Presence

Full Usage: this.Presence

Parameters:
    () : unit

Returns: Lens<Presence, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Presence, Entity>

this.Presence

Full Usage: this.Presence

Returns: Lens<Presence, Entity>

Extended Type: Entity

Returns: Lens<Presence, Entity>

this.PropagatePhysics

Full Usage: this.PropagatePhysics

Parameters:

Propagate entity physics properties into the physics system.

Extended Type: Entity

world : World

this.PropagatedDescriptorOpt

Full Usage: this.PropagatedDescriptorOpt

Parameters:
    () : unit

Returns: Lens<EntityDescriptor option, Entity>

Extended Type: Entity

() : unit
Returns: Lens<EntityDescriptor option, Entity>

this.PropagatedDescriptorOpt

Full Usage: this.PropagatedDescriptorOpt

Returns: Lens<EntityDescriptor option, Entity>

Extended Type: Entity

Returns: Lens<EntityDescriptor option, Entity>

this.PropagationSourceOpt

Full Usage: this.PropagationSourceOpt

Parameters:
    () : unit

Returns: Lens<Entity option, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Entity option, Entity>

this.PropagationSourceOpt

Full Usage: this.PropagationSourceOpt

Returns: Lens<Entity option, Entity>

Extended Type: Entity

Returns: Lens<Entity option, Entity>

this.Protected

Full Usage: this.Protected

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.Protected

Full Usage: this.Protected

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.RayCast

Full Usage: this.RayCast

Parameters:
Returns: Intersection[]

Check that an entity is intersected by a ray.

Extended Type: Entity

ray : Ray3
world : World
Returns: Intersection[]

this.RegisterEvent

Full Usage: this.RegisterEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Entity

() : unit
Returns: unit Address

this.RegisterEvent

Full Usage: this.RegisterEvent

Returns: unit Address

Extended Type: Entity

Returns: unit Address

this.Rotation

Full Usage: this.Rotation

Parameters:
    () : unit

Returns: Lens<Quaternion, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Quaternion, Entity>

this.Rotation

Full Usage: this.Rotation

Returns: Lens<Quaternion, Entity>

Extended Type: Entity

Returns: Lens<Quaternion, Entity>

this.RotationLocal

Full Usage: this.RotationLocal

Parameters:
    () : unit

Returns: Lens<Quaternion, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Quaternion, Entity>

this.RotationLocal

Full Usage: this.RotationLocal

Returns: Lens<Quaternion, Entity>

Extended Type: Entity

Returns: Lens<Quaternion, Entity>

this.Scale

Full Usage: this.Scale

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.Scale

Full Usage: this.Scale

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.ScaleLocal

Full Usage: this.ScaleLocal

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.ScaleLocal

Full Usage: this.ScaleLocal

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.Set

Full Usage: this.Set

Parameters:
    propertyName : string
    value : 'a
    world : World

Set an xtension property value.

Extended Type: Entity

propertyName : string
value : 'a
world : World

this.SetAbsolute

Full Usage: this.SetAbsolute

Parameters:
    value : bool
    world : World

Extended Type: Entity

value : bool
world : World

this.SetAlwaysRender

Full Usage: this.SetAlwaysRender

Parameters:
    value : bool
    world : World

Extended Type: Entity

value : bool
world : World

this.SetAlwaysUpdate

Full Usage: this.SetAlwaysUpdate

Parameters:
    value : bool
    world : World

Extended Type: Entity

value : bool
world : World

this.SetAngles

Full Usage: this.SetAngles

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetAnglesLocal

Full Usage: this.SetAnglesLocal

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetCastShadow

Full Usage: this.SetCastShadow

Parameters:
    value : bool
    world : World

Extended Type: Entity

value : bool
world : World

this.SetDegrees

Full Usage: this.SetDegrees

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetDegreesLocal

Full Usage: this.SetDegreesLocal

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetElevation

Full Usage: this.SetElevation

Parameters:
    value : single
    world : World

Extended Type: Entity

value : single
world : World

this.SetElevationLocal

Full Usage: this.SetElevationLocal

Parameters:
    value : float32
    world : World

Extended Type: Entity

value : float32
world : World

this.SetEnabled

Full Usage: this.SetEnabled

Parameters:
    value : bool
    world : World

Extended Type: Entity

value : bool
world : World

this.SetEnabledLocal

Full Usage: this.SetEnabledLocal

Parameters:
    value : bool
    world : World

Extended Type: Entity

value : bool
world : World

this.SetModelGeneric

Full Usage: this.SetModelGeneric

Parameters:
    value : 'a
    world : World

Extended Type: Entity

value : 'a
world : World

this.SetMountOpt

Full Usage: this.SetMountOpt

Parameters:

Extended Type: Entity

value : Entity Relation option
world : World

this.SetMountOptWithAdjustment

Full Usage: this.SetMountOptWithAdjustment

Parameters:

Set an entity's mount while adjusting its mount properties such that they do not change.

Extended Type: Entity

value : Entity Relation option
world : World

this.SetOffset

Full Usage: this.SetOffset

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetOrder

Full Usage: this.SetOrder

Parameters:
    value : int64
    world : World

Extended Type: Entity

value : int64
world : World

this.SetOverflow

Full Usage: this.SetOverflow

Parameters:
    value : single
    world : World

Extended Type: Entity

value : single
world : World

this.SetPerimeter

Full Usage: this.SetPerimeter

Parameters:

Extended Type: Entity

value : Box3
world : World

this.SetPerimeterBottom

Full Usage: this.SetPerimeterBottom

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetPerimeterBottomLeft

Full Usage: this.SetPerimeterBottomLeft

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetPerimeterBottomLeftLocal

Full Usage: this.SetPerimeterBottomLeftLocal

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetPerimeterBottomLocal

Full Usage: this.SetPerimeterBottomLocal

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetPerimeterCenter

Full Usage: this.SetPerimeterCenter

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetPerimeterCenterLocal

Full Usage: this.SetPerimeterCenterLocal

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetPerimeterMax

Full Usage: this.SetPerimeterMax

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetPerimeterMaxLocal

Full Usage: this.SetPerimeterMaxLocal

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetPerimeterMin

Full Usage: this.SetPerimeterMin

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetPerimeterMinLocal

Full Usage: this.SetPerimeterMinLocal

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetPerimeterUnscaled

Full Usage: this.SetPerimeterUnscaled

Parameters:

Extended Type: Entity

value : Box3
world : World

this.SetPersistent

Full Usage: this.SetPersistent

Parameters:
    value : bool
    world : World

Extended Type: Entity

value : bool
world : World

this.SetPickable

Full Usage: this.SetPickable

Parameters:
    value : bool
    world : World

Extended Type: Entity

value : bool
world : World

this.SetPosition

Full Usage: this.SetPosition

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetPositionLocal

Full Usage: this.SetPositionLocal

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetPresence

Full Usage: this.SetPresence

Parameters:

Extended Type: Entity

value : Presence
world : World

this.SetPropagatedDescriptorOpt

Full Usage: this.SetPropagatedDescriptorOpt

Parameters:

Extended Type: Entity

value : EntityDescriptor option
world : World

this.SetPropagationSourceOpt

Full Usage: this.SetPropagationSourceOpt

Parameters:

Extended Type: Entity

value : Entity option
world : World

this.SetProperty

Full Usage: this.SetProperty

Parameters:

Set a property value with explicit type.

Extended Type: Entity

propertyName : string
property : Property
world : World

this.SetRotation

Full Usage: this.SetRotation

Parameters:

Extended Type: Entity

value : Quaternion
world : World

this.SetRotationLocal

Full Usage: this.SetRotationLocal

Parameters:

Extended Type: Entity

value : Quaternion
world : World

this.SetScale

Full Usage: this.SetScale

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetScaleLocal

Full Usage: this.SetScaleLocal

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetSize

Full Usage: this.SetSize

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetStatic

Full Usage: this.SetStatic

Parameters:
    value : bool
    world : World

Extended Type: Entity

value : bool
world : World

this.SetTransform

Full Usage: this.SetTransform

Parameters:

Extended Type: Entity

value : Transform
world : World

this.SetTransformByRef

Full Usage: this.SetTransformByRef

Parameters:
Returns: bool

Set the transform of an entity.

Extended Type: Entity

value : byref<Transform>
world : World
Returns: bool

this.SetTransformByRefWithoutEvent

Full Usage: this.SetTransformByRefWithoutEvent

Parameters:

Set the transform of an entity without generating any change events.

Extended Type: Entity

value : inref<Transform>
world : World

this.SetTransformPositionSnapped

Full Usage: this.SetTransformPositionSnapped

Parameters:

Set the transform of an entity snapped to the give position and rotation snaps.

Extended Type: Entity

positionSnap : single
value : Transform
world : World

this.SetTransformWithoutEvent

Full Usage: this.SetTransformWithoutEvent

Parameters:

Set the transform of an entity without generating any change events.

Extended Type: Entity

value : Transform
world : World

this.SetVisible

Full Usage: this.SetVisible

Parameters:
    value : bool
    world : World

Extended Type: Entity

value : bool
world : World

this.SetVisibleLocal

Full Usage: this.SetVisibleLocal

Parameters:
    value : bool
    world : World

Extended Type: Entity

value : bool
world : World

this.Signal

Full Usage: this.Signal

Parameters:

Send a signal to an entity.

Extended Type: Entity

signal : Signal
world : World

this.Size

Full Usage: this.Size

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.Size

Full Usage: this.Size

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.Static

Full Usage: this.Static

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.Static

Full Usage: this.Static

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.Transform

Full Usage: this.Transform

Parameters:
    () : unit

Returns: Lens<Transform, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Transform, Entity>

this.Transform

Full Usage: this.Transform

Returns: Lens<Transform, Entity>

Extended Type: Entity

Returns: Lens<Transform, Entity>

this.TraverseChildren

Full Usage: this.TraverseChildren

Parameters:
Returns: World

Traverse an entity's children.

Extended Type: Entity

effect : Entity -> Entity -> World -> World
world : World
Returns: World

this.TraverseMounters

Full Usage: this.TraverseMounters

Parameters:

Traverse an entity's mounters.

Extended Type: Entity

effect : Entity -> Entity -> World -> unit
world : World

this.TryGet

Full Usage: this.TryGet

Parameters:
    propertyName : string
    world : World

Returns: 'a voption

Try to get an xtension property value.

Extended Type: Entity

propertyName : string
world : World
Returns: 'a voption

this.TryGetMountee

Full Usage: this.TryGetMountee

Parameters:
Returns: Entity option

Attempt to get an entity on which this entity is mounted.

Extended Type: Entity

world : World
Returns: Entity option

this.TryGetProperty

Full Usage: this.TryGetProperty

Parameters:
    propertyName : string
    world : World

Returns: Property option

Try to get a property value and type.

Extended Type: Entity

propertyName : string
world : World
Returns: Property option

this.TrySet

Full Usage: this.TrySet

Parameters:
    propertyName : string
    value : 'a
    world : World

Returns: bool * bool

To try set an xtension property value.

Extended Type: Entity

propertyName : string
value : 'a
world : World
Returns: bool * bool

this.TrySetProperty

Full Usage: this.TrySetProperty

Parameters:
Returns: bool * bool

Try to set a property value with explicit type.

Extended Type: Entity

propertyName : string
property : Property
world : World
Returns: bool * bool

this.UnmountEvent

Full Usage: this.UnmountEvent

Parameters:
    () : unit

Returns: MountData Address

Extended Type: Entity

() : unit
Returns: MountData Address

this.UnmountEvent

Full Usage: this.UnmountEvent

Returns: MountData Address

Extended Type: Entity

Returns: MountData Address

this.UnregisteringEvent

Full Usage: this.UnregisteringEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Entity

() : unit
Returns: unit Address

this.UnregisteringEvent

Full Usage: this.UnregisteringEvent

Returns: unit Address

Extended Type: Entity

Returns: unit Address

this.UpdateEvent

Full Usage: this.UpdateEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Entity

() : unit
Returns: unit Address

this.UpdateEvent

Full Usage: this.UpdateEvent

Returns: unit Address

Extended Type: Entity

Returns: unit Address

this.Visible

Full Usage: this.Visible

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.Visible

Full Usage: this.Visible

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.VisibleLocal

Full Usage: this.VisibleLocal

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.VisibleLocal

Full Usage: this.VisibleLocal

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

World.canPasteEntityFromClipboard arg1

Full Usage: World.canPasteEntityFromClipboard arg1

Parameters:
Returns: bool

Check that there's an entity on the world's clipboard to paste.

Extended Type: World

arg0 : World
Returns: bool

World.clearEntityFromClipboard arg1

Full Usage: World.clearEntityFromClipboard arg1

Parameters:

Clear any entity on the world's clipboard.

Extended Type: World

arg0 : World

World.copyEntityToClipboard entity world

Full Usage: World.copyEntityToClipboard entity world

Parameters:

Copy an entity to the world's clipboard.

Extended Type: World

entity : Entity
world : World

World.cutEntityToClipboard entity world

Full Usage: World.cutEntityToClipboard entity world

Parameters:

Cut an entity to the world's clipboard.

Extended Type: World

entity : Entity
world : World

World.destroyEntities entities world

Full Usage: World.destroyEntities entities world

Parameters:

Destroy multiple entities in the world at the end of the current update.

Extended Type: World

entities : Entity seq
world : World

World.destroyEntitiesImmediate entities world

Full Usage: World.destroyEntitiesImmediate entities world

Parameters:

Destroy multiple entities in the world immediately. Can be dangerous if existing in-flight publishing depends on any of the entities' existences. Consider using World.destroyEntities instead.

Extended Type: World

entities : Entity seq
world : World

World.destroyEntity entity world

Full Usage: World.destroyEntity entity world

Parameters:

Destroy an entity in the world at the end of the current update.

Extended Type: World

entity : Entity
world : World

World.editEntity operation entity world

Full Usage: World.editEntity operation entity world

Parameters:

Edit an entity with the given operation using the ImGui APIs. Intended only to be called by editors like Gaia.

Extended Type: World

operation : EditOperation
entity : Entity
world : World

World.generateEntitySequentialName dispatcherName group world

Full Usage: World.generateEntitySequentialName dispatcherName group world

Parameters:
    dispatcherName : string
    group : Group
    world : World

Returns: string

Generate a sequential, editor-friendly entity name.

Extended Type: World

dispatcherName : string
group : Group
world : World
Returns: string

World.getEntities group world

Full Usage: World.getEntities group world

Parameters:
Returns: Entity USet

Get all the entities in a group.

Extended Type: World

group : Group
world : World
Returns: Entity USet

World.getEntitiesAs group world

Full Usage: World.getEntitiesAs group world

Parameters:
Returns: Entity USet

Get all the entities in a group with the given dispatcher type.

Extended Type: World

group : Group
world : World
Returns: Entity USet

World.getEntitiesDepthFirst group world

Full Usage: World.getEntitiesDepthFirst group world

Parameters:
Returns: Entity seq

Get all the entities in a group in depth-first order.

Extended Type: World

group : Group
world : World
Returns: Entity seq

World.getEntitiesWith group world

Full Usage: World.getEntitiesWith group world

Parameters:
Returns: Entity USet

Get all the entities in a group that have a given facet type.

Extended Type: World

group : Group
world : World
Returns: Entity USet

World.getSovereignEntities group world

Full Usage: World.getSovereignEntities group world

Parameters:
Returns: Entity seq

Get all the entities directly parented by the group.

Extended Type: World

group : Group
world : World
Returns: Entity seq

World.insertEntityOrder entity previousOpt next world

Full Usage: World.insertEntityOrder entity previousOpt next world

Parameters:

Insert an entity's order between optional previous entity and next entity.

Extended Type: World

entity : Entity
previousOpt : Entity option
next : Entity
world : World

World.pasteEntity distance rightClickPosition positionSnapEir pasteType entity parent world

Full Usage: World.pasteEntity distance rightClickPosition positionSnapEir pasteType entity parent world

Parameters:
Returns: Entity

Paste an entity.

Extended Type: World

distance : single
rightClickPosition : Vector2
positionSnapEir : Either<single, single>
pasteType : PasteType
entity : Entity
parent : Simulant
world : World
Returns: Entity

World.pasteEntityFromDescriptor distance rightClickPosition positionSnapEir pasteType cut entityDescriptor entitySource parent world

Full Usage: World.pasteEntityFromDescriptor distance rightClickPosition positionSnapEir pasteType cut entityDescriptor entitySource parent world

Parameters:
Returns: Entity

Paste an entity from the given entity descriptor.

Extended Type: World

distance : single
rightClickPosition : Vector2
positionSnapEir : Either<single, single>
pasteType : PasteType
cut : bool
entityDescriptor : EntityDescriptor
entitySource : Entity
parent : Simulant
world : World
Returns: Entity

World.renameEntity source destination world

Full Usage: World.renameEntity source destination world

Parameters:

Rename an entity.

Extended Type: World

source : Entity
destination : Entity
world : World

World.renameEntityImmediate source destination world

Full Usage: World.renameEntityImmediate source destination world

Parameters:

Rename an entity. Note that since this destroys the renamed entity immediately, you should not call this inside an event handler that involves the reassigned entity itself. Note this also renames all of its descendents accordingly.

Extended Type: World

source : Entity
destination : Entity
world : World

World.sortEntities2d entities world

Full Usage: World.sortEntities2d entities world

Parameters:
Returns: Entity array

Sort the given entities by 2d sorting priority. If there are a lot of entities, this may allocate in the LOH.

Extended Type: World

entities : Entity seq
world : World
Returns: Entity array

World.swapEntityOrders entity entity2 world

Full Usage: World.swapEntityOrders entity entity2 world

Parameters:

Swap the orders of two entities.

Extended Type: World

entity : Entity
entity2 : Entity
world : World

World.tryGetNextEntity entity world

Full Usage: World.tryGetNextEntity entity world

Parameters:
Returns: Entity option

Try to find the entity among the given entity's peers with the closest next order.

Extended Type: World

entity : Entity
world : World
Returns: Entity option

World.tryGetPreviousEntity entity world

Full Usage: World.tryGetPreviousEntity entity world

Parameters:
Returns: Entity option

Try to find the entity among the given entity's peers with the closest previous order.

Extended Type: World

entity : Entity
world : World
Returns: Entity option

World.tryPasteEntityFromClipboard distance rightClickPosition positionSnapEir pasteType parent world

Full Usage: World.tryPasteEntityFromClipboard distance rightClickPosition positionSnapEir pasteType parent world

Parameters:
Returns: Entity option

Paste an entity from the world's clipboard.

Extended Type: World

distance : single
rightClickPosition : Vector2
positionSnapEir : Either<single, single>
pasteType : PasteType
parent : Simulant
world : World
Returns: Entity option

World.tryPickEntity2d position entities world

Full Usage: World.tryPickEntity2d position entities world

Parameters:
Returns: Entity option

Attempt to pick an entity at the given position.

Extended Type: World

position : Vector2
entities : Entity seq
world : World
Returns: Entity option

World.tryPickEntity3d position entities world

Full Usage: World.tryPickEntity3d position entities world

Parameters:
Returns: (single * Entity) option

Attempt to pick a 3d entity with the given ray.

Extended Type: World

position : Vector2
entities : Entity seq
world : World
Returns: (single * Entity) option

World.tryTruncateEntityModel model entity world

Full Usage: World.tryTruncateEntityModel model entity world

Parameters:
Returns: 'model option

Attempt to truncate an entity model.

Extended Type: World

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

World.tryUntruncateEntityModel model entity world

Full Usage: World.tryUntruncateEntityModel model entity world

Parameters:
Returns: 'model option

Attempt to untruncate an entity model.

Extended Type: World

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

Type something to start searching.