Skip to main content

Entity

@3dverse/livelink v0.8.10


@3dverse/livelink / Entity

Class: Entity

Defined in: livelink.js/sources/scene/Entity.ts:46

An entity in a scene.

An entity is a collection of components.

This class embeds a proxy to monitor component access and mark the entity as dirty when a component is added, modified or deleted.

All relevant modifications to entities are batched and sent to the server if the auto_update property is set to "on" and broadcasted to other clients if the auto_broadcast property is set to "on".

On top of providing direct access to the components, this class provides helper methods to retrieve the parent entity and the children entities.

This class cannot be instantiated directly. Use the Scene.newEntity or Scene.newEntities methods on an existing scene to create an entity.

Extends

  • EntityBase

Accessors

euid

Get Signature

get euid(): Readonly<Euid>

Defined in: livelink.js/_prebuild/EntityBase.ts:74

Returns

Readonly<Euid>

Inherited from

EntityBase.euid


animation_controller

Get Signature

get animation_controller(): undefined | AnimationController

Defined in: livelink.js/_prebuild/EntityBase.ts:81

Animation controller with reference to an animation graph and an animation set. Enables skeletal animation on its skinned mesh descendents whose skeleton is compatible with the animations in the animation set.

Returns

undefined | AnimationController

Set Signature

set animation_controller(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:85

Parameters
value

undefined | Partial<AnimationController> | "default"

Returns

void

Inherited from

EntityBase.animation_controller


animation_sequence_controller

Get Signature

get animation_sequence_controller(): undefined | AnimationSequenceController

Defined in: livelink.js/_prebuild/EntityBase.ts:92

Animation sequence controller with reference to an animation sequence and assigned entities.

Returns

undefined | AnimationSequenceController

Set Signature

set animation_sequence_controller(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:96

Parameters
value

undefined | "default" | Partial<AnimationSequenceController>

Returns

void

Inherited from

EntityBase.animation_sequence_controller


bone

Get Signature

get bone(): undefined | Bone

Defined in: livelink.js/_prebuild/EntityBase.ts:103

Links entity to bone in skeleton.

Returns

undefined | Bone

Set Signature

set bone(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:107

Parameters
value

undefined | "default" | Partial<Bone>

Returns

void

Inherited from

EntityBase.bone


box_geometry

Get Signature

get box_geometry(): undefined | BoxGeometry

Defined in: livelink.js/_prebuild/EntityBase.ts:114

Box geometry.

Returns

undefined | BoxGeometry

Set Signature

set box_geometry(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:118

Parameters
value

undefined | "default" | Partial<BoxGeometry>

Returns

void

Inherited from

EntityBase.box_geometry


camera

Get Signature

get camera(): undefined | Camera

Defined in: livelink.js/_prebuild/EntityBase.ts:125

Virtual camera.

Returns

undefined | Camera

Set Signature

set camera(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:129

Parameters
value

undefined | "default" | Partial<Camera>

Returns

void

Inherited from

EntityBase.camera


capsule_geometry

Get Signature

get capsule_geometry(): undefined | CapsuleGeometry

Defined in: livelink.js/_prebuild/EntityBase.ts:136

Capsule geometry.

Returns

undefined | CapsuleGeometry

Set Signature

set capsule_geometry(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:140

Parameters
value

undefined | "default" | Partial<CapsuleGeometry>

Returns

void

Inherited from

EntityBase.capsule_geometry


character_controller

Get Signature

get character_controller(): undefined | CharacterController

Defined in: livelink.js/_prebuild/EntityBase.ts:147

Character controller used for movement constrained by collisions without having to deal with a rigid body. A character controller is kinematic, and so is not affected by forces. It uses its own tweaked collision algorithm to give a good feeling while controlling the character.

Returns

undefined | CharacterController

Set Signature

set character_controller(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:151

Parameters
value

undefined | "default" | Partial<CharacterController>

Returns

void

Inherited from

EntityBase.character_controller


collision_geometry_ref

Get Signature

get collision_geometry_ref(): undefined | CollisionGeometryRef

Defined in: livelink.js/_prebuild/EntityBase.ts:158

Reference to a collision geometry.

Returns

undefined | CollisionGeometryRef

Set Signature

set collision_geometry_ref(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:162

Parameters
value

undefined | "default" | Partial<CollisionGeometryRef>

Returns

void

Inherited from

EntityBase.collision_geometry_ref


constraint

Get Signature

get constraint(): undefined | Constraint

Defined in: livelink.js/_prebuild/EntityBase.ts:169

A physics constraint that can be configured along 6 degrees of freedom. In its default state it behaves as a fixed constraint - that is, it rigidly fixes the constraint frames of its two entities. However, individual degrees of freedom may be unlocked to permit any combination of rotation around the x-, y- and z- axes, and translation along these axes.

Returns

undefined | Constraint

Set Signature

set constraint(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:173

Parameters
value

undefined | "default" | Partial<Constraint>

Returns

void

Inherited from

EntityBase.constraint


culling_geometry

Get Signature

get culling_geometry(): undefined | CullingGeometry

Defined in: livelink.js/_prebuild/EntityBase.ts:180

Culling geometry. Add this component in addition to another geometry component (e.g. box geometry, sphere geometry, etc.) to enable culling geometry.

Returns

undefined | CullingGeometry

Set Signature

set culling_geometry(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:184

Parameters
value

undefined | "default" | Partial<CullingGeometry>

Returns

void

Inherited from

EntityBase.culling_geometry


cylinder_geometry

Get Signature

get cylinder_geometry(): undefined | CylinderGeometry

Defined in: livelink.js/_prebuild/EntityBase.ts:191

Cylinder geometry.

Returns

undefined | CylinderGeometry

Set Signature

set cylinder_geometry(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:195

Parameters
value

undefined | "default" | Partial<CylinderGeometry>

Returns

void

Inherited from

EntityBase.cylinder_geometry


debug_name

Get Signature

get debug_name(): undefined | DebugName

Defined in: livelink.js/_prebuild/EntityBase.ts:202

Name of the entity.

Returns

undefined | DebugName

Set Signature

set debug_name(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:206

Parameters
value

undefined | "default" | Partial<DebugName>

Returns

void

Inherited from

EntityBase.debug_name


decal_projector

Get Signature

get decal_projector(): undefined | DecalProjector

Defined in: livelink.js/_prebuild/EntityBase.ts:213

Decal Projector.

Returns

undefined | DecalProjector

Set Signature

set decal_projector(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:217

Parameters
value

undefined | "default" | Partial<DecalProjector>

Returns

void

Inherited from

EntityBase.decal_projector


environment

Get Signature

get environment(): undefined | Environment

Defined in: livelink.js/_prebuild/EntityBase.ts:224

The environment of a scene. Used to give a scene a skybox.

Returns

undefined | Environment

Set Signature

set environment(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:228

Parameters
value

undefined | "default" | Partial<Environment>

Returns

void

Inherited from

EntityBase.environment


joint

Get Signature

get joint(): undefined | Joint

Defined in: livelink.js/_prebuild/EntityBase.ts:235

Base component of all the other joint components (revolute_joint, etc.). By itself it will lock the orientations and distances of the constrainer and constrainee.

Returns

undefined | Joint

Set Signature

set joint(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:239

Parameters
value

undefined | "default" | Partial<Joint>

Returns

void

Inherited from

EntityBase.joint


lineage

Get Signature

get lineage(): undefined | Lineage

Defined in: livelink.js/_prebuild/EntityBase.ts:246

Lineage of the entity through linkers.

Returns

undefined | Lineage

Set Signature

set lineage(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:250

Parameters
value

undefined | "default" | Partial<Lineage>

Returns

void

Inherited from

EntityBase.lineage


local_aabb

Get Signature

get local_aabb(): undefined | LocalAabb

Defined in: livelink.js/_prebuild/EntityBase.ts:257

Local Axis Aligned Bounding Box of the entity.

Returns

undefined | LocalAabb

Set Signature

set local_aabb(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:261

Parameters
value

undefined | "default" | Partial<LocalAabb>

Returns

void

Inherited from

EntityBase.local_aabb


local_transform

Get Signature

get local_transform(): undefined | LocalTransform

Defined in: livelink.js/_prebuild/EntityBase.ts:268

Local transform of the entity.

Returns

undefined | LocalTransform

Set Signature

set local_transform(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:272

Parameters
value

undefined | "default" | Partial<LocalTransform>

Returns

void

Inherited from

EntityBase.local_transform


material

Get Signature

get material(): undefined | Material

Defined in: livelink.js/_prebuild/EntityBase.ts:279

References a shader and specifies input values if needed.

Returns

undefined | Material

Set Signature

set material(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:283

Parameters
value

undefined | "default" | Partial<Material>

Returns

void

Inherited from

EntityBase.material


material_ref

Get Signature

get material_ref(): undefined | MaterialRef

Defined in: livelink.js/_prebuild/EntityBase.ts:290

Reference to a material.

Returns

undefined | MaterialRef

Set Signature

set material_ref(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:294

Parameters
value

undefined | "default" | Partial<MaterialRef>

Returns

void

Inherited from

EntityBase.material_ref


mesh_ref

Get Signature

get mesh_ref(): undefined | MeshRef

Defined in: livelink.js/_prebuild/EntityBase.ts:301

Reference to a mesh.

Returns

undefined | MeshRef

Set Signature

set mesh_ref(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:305

Parameters
value

undefined | "default" | Partial<MeshRef>

Returns

void

Inherited from

EntityBase.mesh_ref


orthographic_lens

Get Signature

get orthographic_lens(): undefined | OrthographicLens

Defined in: livelink.js/_prebuild/EntityBase.ts:312

A lens that applies an orthographic projection.

Returns

undefined | OrthographicLens

Set Signature

set orthographic_lens(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:316

Parameters
value

undefined | "default" | Partial<OrthographicLens>

Returns

void

Inherited from

EntityBase.orthographic_lens


overrider

Get Signature

get overrider(): undefined | Overrider

Defined in: livelink.js/_prebuild/EntityBase.ts:323

Overrides a given entity in a sub scene.

Returns

undefined | Overrider

Set Signature

set overrider(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:327

Parameters
value

undefined | "default" | Partial<Overrider>

Returns

void

Inherited from

EntityBase.overrider


perspective_lens

Get Signature

get perspective_lens(): undefined | PerspectiveLens

Defined in: livelink.js/_prebuild/EntityBase.ts:334

A lens that applies a perspective projection.

Returns

undefined | PerspectiveLens

Set Signature

set perspective_lens(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:338

Parameters
value

undefined | "default" | Partial<PerspectiveLens>

Returns

void

Inherited from

EntityBase.perspective_lens


physics_material

Get Signature

get physics_material(): undefined | PhysicsMaterial

Defined in: livelink.js/_prebuild/EntityBase.ts:345

Physics material which represents a set of physical surface properties.

Returns

undefined | PhysicsMaterial

Set Signature

set physics_material(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:349

Parameters
value

undefined | "default" | Partial<PhysicsMaterial>

Returns

void

Inherited from

EntityBase.physics_material


plane_geometry

Get Signature

get plane_geometry(): undefined | PlaneGeometry

Defined in: livelink.js/_prebuild/EntityBase.ts:356

Plane geometry.

Returns

undefined | PlaneGeometry

Set Signature

set plane_geometry(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:360

Parameters
value

undefined | "default" | Partial<PlaneGeometry>

Returns

void

Inherited from

EntityBase.plane_geometry


point_cloud_ref

Get Signature

get point_cloud_ref(): undefined | PointCloudRef

Defined in: livelink.js/_prebuild/EntityBase.ts:367

Reference to a point cloud.

Returns

undefined | PointCloudRef

Set Signature

set point_cloud_ref(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:371

Parameters
value

undefined | "default" | Partial<PointCloudRef>

Returns

void

Inherited from

EntityBase.point_cloud_ref


point_light

Get Signature

get point_light(): undefined | PointLight

Defined in: livelink.js/_prebuild/EntityBase.ts:378

A light with color and intensity. A point light by default, add a spot light component to add a cutoff. Can be parameterized to simulate the atmosphere sun.

Returns

undefined | PointLight

Set Signature

set point_light(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:382

Parameters
value

undefined | "default" | Partial<PointLight>

Returns

void

Inherited from

EntityBase.point_light


reflection_probe

Get Signature

get reflection_probe(): undefined | ReflectionProbe

Defined in: livelink.js/_prebuild/EntityBase.ts:389

Omni directional reflection probe parameters, used for local cubemap reflection generation.

Returns

undefined | ReflectionProbe

Set Signature

set reflection_probe(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:393

Parameters
value

undefined | "default" | Partial<ReflectionProbe>

Returns

void

Inherited from

EntityBase.reflection_probe


rigid_body

Get Signature

get rigid_body(): undefined | RigidBody

Defined in: livelink.js/_prebuild/EntityBase.ts:400

Rigid body parameters.

Returns

undefined | RigidBody

Set Signature

set rigid_body(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:404

Parameters
value

undefined | "default" | Partial<RigidBody>

Returns

void

Inherited from

EntityBase.rigid_body


scene_ref

Get Signature

get scene_ref(): undefined | SceneRef

Defined in: livelink.js/_prebuild/EntityBase.ts:411

Reference to a scene.

Returns

undefined | SceneRef

Set Signature

set scene_ref(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:415

Parameters
value

undefined | "default" | Partial<SceneRef>

Returns

void

Inherited from

EntityBase.scene_ref


script_map

Get Signature

get script_map(): undefined | ScriptMap

Defined in: livelink.js/_prebuild/EntityBase.ts:422

References multiple scripts.

Returns

undefined | ScriptMap

Set Signature

set script_map(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:426

Parameters
value

undefined | "default" | Partial<ScriptMap>

Returns

void

Inherited from

EntityBase.script_map


shadow_caster

Get Signature

get shadow_caster(): undefined | ShadowCaster

Defined in: livelink.js/_prebuild/EntityBase.ts:433

Enables a light to cast shadows.

Returns

undefined | ShadowCaster

Set Signature

set shadow_caster(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:437

Parameters
value

undefined | "default" | Partial<ShadowCaster>

Returns

void

Inherited from

EntityBase.shadow_caster


skeleton_ref

Get Signature

get skeleton_ref(): undefined | SkeletonRef

Defined in: livelink.js/_prebuild/EntityBase.ts:444

Reference to a skeleton.

Returns

undefined | SkeletonRef

Set Signature

set skeleton_ref(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:448

Parameters
value

undefined | "default" | Partial<SkeletonRef>

Returns

void

Inherited from

EntityBase.skeleton_ref


sound_ref

Get Signature

get sound_ref(): undefined | SoundRef

Defined in: livelink.js/_prebuild/EntityBase.ts:455

Reference to a sound.

Returns

undefined | SoundRef

Set Signature

set sound_ref(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:459

Parameters
value

undefined | "default" | Partial<SoundRef>

Returns

void

Inherited from

EntityBase.sound_ref


sphere_geometry

Get Signature

get sphere_geometry(): undefined | SphereGeometry

Defined in: livelink.js/_prebuild/EntityBase.ts:466

Sphere geometry.

Returns

undefined | SphereGeometry

Set Signature

set sphere_geometry(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:470

Parameters
value

undefined | "default" | Partial<SphereGeometry>

Returns

void

Inherited from

EntityBase.sphere_geometry


spot_light

Get Signature

get spot_light(): undefined | SpotLight

Defined in: livelink.js/_prebuild/EntityBase.ts:477

Adds a cutoff to a point light to simulate a spot light.

Returns

undefined | SpotLight

Set Signature

set spot_light(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:481

Parameters
value

undefined | "default" | Partial<SpotLight>

Returns

void

Inherited from

EntityBase.spot_light


stereoscopic_lens

Get Signature

get stereoscopic_lens(): undefined | StereoscopicLens

Defined in: livelink.js/_prebuild/EntityBase.ts:488

A lens that applies a custom projection.

Returns

undefined | StereoscopicLens

Set Signature

set stereoscopic_lens(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:492

Parameters
value

undefined | "default" | Partial<StereoscopicLens>

Returns

void

Inherited from

EntityBase.stereoscopic_lens


tags

Get Signature

get tags(): undefined | Tags

Defined in: livelink.js/_prebuild/EntityBase.ts:499

Tags used to filter entities.

Returns

undefined | Tags

Set Signature

set tags(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:503

Parameters
value

undefined | "default" | Partial<Tags>

Returns

void

Inherited from

EntityBase.tags


vehicle_controller

Get Signature

get vehicle_controller(): undefined | VehicleController

Defined in: livelink.js/_prebuild/EntityBase.ts:510

Vehicle Controller parameters.

Returns

undefined | VehicleController

Set Signature

set vehicle_controller(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:514

Parameters
value

undefined | "default" | Partial<VehicleController>

Returns

void

Inherited from

EntityBase.vehicle_controller


volume_filter

Get Signature

get volume_filter(): undefined | VolumeFilter

Defined in: livelink.js/_prebuild/EntityBase.ts:521

Filtering properties applied to the volume.

Returns

undefined | VolumeFilter

Set Signature

set volume_filter(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:525

Parameters
value

undefined | "default" | Partial<VolumeFilter>

Returns

void

Inherited from

EntityBase.volume_filter


volume_material_ref

Get Signature

get volume_material_ref(): undefined | VolumeMaterialRef

Defined in: livelink.js/_prebuild/EntityBase.ts:532

Reference to a material to use with a volume.

Returns

undefined | VolumeMaterialRef

Set Signature

set volume_material_ref(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:536

Parameters
value

undefined | "default" | Partial<VolumeMaterialRef>

Returns

void

Inherited from

EntityBase.volume_material_ref


volume_ref

Get Signature

get volume_ref(): undefined | VolumeRef

Defined in: livelink.js/_prebuild/EntityBase.ts:543

Reference to a volume made of voxels.

Returns

undefined | VolumeRef

Set Signature

set volume_ref(value): void

Defined in: livelink.js/_prebuild/EntityBase.ts:547

Parameters
value

undefined | "default" | Partial<VolumeRef>

Returns

void

Inherited from

EntityBase.volume_ref


id

Get Signature

get id(): UUID

Defined in: livelink.js/sources/scene/Entity.ts:95

The UUID of the entity.

Note that multiple entities can share the same UUID if they are different instances of the same entity brought by multiple instances of the same scene.

Returns

UUID


name

Get Signature

get name(): string

Defined in: livelink.js/sources/scene/Entity.ts:102

The name of the entity.

Returns

string


auto_update

Get Signature

get auto_update(): EntityAutoUpdateState

Defined in: livelink.js/sources/scene/Entity.ts:109

Whether the entity has its components updates sent to the server.

Returns

EntityAutoUpdateState

Set Signature

set auto_update(state): void

Defined in: livelink.js/sources/scene/Entity.ts:116

Set whether the entity has its components updates sent to the server.

Parameters
state

EntityAutoUpdateState

Returns

void


auto_broadcast

Get Signature

get auto_broadcast(): EntityAutoUpdateState

Defined in: livelink.js/sources/scene/Entity.ts:123

Whether the entity has its components updates broadcasted to other clients.

Returns

EntityAutoUpdateState

Set Signature

set auto_broadcast(state): void

Defined in: livelink.js/sources/scene/Entity.ts:130

Set whether the entity has its components updates broadcasted to other clients.

Parameters
state

EntityAutoUpdateState

Returns

void


is_visible

Get Signature

get is_visible(): boolean

Defined in: livelink.js/sources/scene/Entity.ts:140

Whether the entity is visible.

Returns

boolean

Set Signature

set is_visible(is_visible): void

Defined in: livelink.js/sources/scene/Entity.ts:147

Set whether the entity is visible.

Parameters
is_visible

boolean

Returns

void


parent

Get Signature

get parent(): null | Entity

Defined in: livelink.js/sources/scene/Entity.ts:155

The parent entity of this entity or null if it has no parent.

Returns

null | Entity

Set Signature

set parent(parent): void

Defined in: livelink.js/sources/scene/Entity.ts:162

Parameters
parent

null | Entity

Returns

void

Methods

toJSON()

toJSON(): object

Defined in: livelink.js/_prebuild/EntityBase.ts:562

Returns

object

Inherited from

EntityBase.toJSON


getChildren()

getChildren(): Promise<Entity[]>

Defined in: livelink.js/sources/scene/Entity.ts:217

Returns

Promise<Entity[]>


assignClientToScripts()

assignClientToScripts(__namedParameters): Promise<void>

Defined in: livelink.js/sources/scene/Entity.ts:224

Experimental

Parameters

__namedParameters
client_uuid

UUID

Returns

Promise<void>


addEventListener()

addEventListener(type, callback, options?): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8303

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference

Parameters

type

string

callback

null | EventListenerOrEventListenerObject

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

EntityBase.addEventListener


dispatchEvent()

dispatchEvent(event): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8309

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference

Parameters

event

Event

Returns

boolean

Inherited from

EntityBase.dispatchEvent


removeEventListener()

removeEventListener(type, callback, options?): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:8315

Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference

Parameters

type

string

callback

null | EventListenerOrEventListenerObject

options?

boolean | EventListenerOptions

Returns

void

Inherited from

EntityBase.removeEventListener