Gets the disposed status of the entity.
The disposed status.
An array of the elements that this component instance exposes. In the case that this component does not expose any elements of its own, this will be an array of the elements exposed by this component's children.
Returns true if this component, or any of its parents, are marked as locked.
Gets a behavior of a specific type from the component.
The type of behavior to get.
The behavior of the specified type, or undefined if no such behavior exists.
Gets all behaviors of a specific type from the component.
The type of behaviors to get.
An array of behaviors of the specified type.
Get the instance of the ZComponent that constructed this entity.
If you pass the class of a ZComponent as the type
parameter, this function will ensure that it
returns an instance of that ZComponent. If this component or behavior was constructed by a different
ZComponent class, or by a different entity altogether, the function with throw
an error.
Optional
type: ConstructorForComponent<T>The ZComponent class that you are expecting to receive
The instance of the ZComponent that constructed this component or behavior
Register a function to be called when an Event is fired, or an Observable's value changes. The function will only be bound to the underlying Event or Observable while this entity is enabled.
Using this function, rather than attaching your handler directly to the Event or Observable, ensures your handler is automatically released when this entity is disposed.
Rest
...args: ArgsOptional
options: RegisterOptionsOptional
options: RegisterOptionsReadonly
tagsAn array of string 'tags' assocated with this component.
The getComponentsByTag(mgr, tag)
function can be used to get an array of components
with the supplied tag.
By default, tags are scoped to the ZComponent instance that a component is constructed by.
Tags that begin with global:
are scoped to the experience as a whole.
The angle forward that the user must push the thumbstick or touchpad within to start the teleport.
The amount (between 0 and 1) the user has to push the thumbstick or touchpad to start the teleport.
If set, this layer clip will be played when the user ends the teleporting process.
If set, this layer clip will be played when the user starts the teleporting process.
Determines if this object casts shadows.
Determines if this object receives shadows.
Determines if this object and its children are rendered to the screen.
Readonly
enabledIf false
, this entity and its children will no longer participate in the experience.
Note - to read this value, you may wish to use enabledResolved
which will be false
if
this entity, or any of its parents, have enabled
set to false.
The precise implications of enabled
being false will vary between entities,
but in general disabled entities:
If true, controllers considered to be for the left hand will allow teleporting.
If true, controllers considered to be for the right hand will allow teleporting.
If true, controllers without a specified 'handedness' will allow teleporting.
If true, the user can use controller thumbsticks to initiate teleport.
If true, the user can use controller touchpads to initiate teleport.
Readonly
behaviorsThe behaviors attached to this component.
Readonly
childrenThe children of this component.
Readonly
contextThe THREE.Group object that represents this component.
Readonly
enabledThis will have value false
if this entity, or any of its parents, have enabled
set to false
.
To change the enabled
status of this entity, use the enabled
property instead.
The precise implications of enabled
being false will vary between entities,
but in general disabled entities:
Disabled entities will typically remain visible (if they have a visible appearance).
Optional
lockedIf true, this component can't be selected at design time in the 3D preview.
Readonly
onAn event that is fired as the last act of this entity being destroyed.
Optional
parentThe parent of this component.
If true, this node will show its content at design time.
If true, this node will show a ring at the intended destination while the user is selecting it.
The position, in 3D space, of this node relative to its parent. The three elements of the array correspond to the x
, y
, and z
components of position.
The rotation, in three dimensions, of this node relative to its parent. The three elements of the array correspond to Euler angles - yaw, pitch and roll.
The scale, in three dimensions, of this node relative to its parent. The three elements of the array correspond to scales in the the x
, y
, and z
axis.
This component allows the user to move around in the scene by teleporting between locations in the scene. With the thumbstick or touchpad held forward, the user can indicate their intended destination my pointing with their controller. Letting go of the thumbstick or touchpad completes the action, moving the user to that location.
This component will, by default, show a ring at the intended location while the user is selecting it. This can be disabled with the
showDestinationRing
parameter. In addition, any content placed within this node will appear at the intended location during selection.Zicon
my_location
Ztag
three/Object3D/Group/TeleportManager
Zparents
three/Object3D/Group/**