[Home](./index.md) > [server](./server.md) > [Entity](./server.entity.md) ## Entity class Represents an entity in a world. **Signature:** ```typescript export default class Entity extends RigidBody implements protocol.Serializable ``` **Extends:** [RigidBody](./server.rigidbody.md) **Implements:** protocol.Serializable ## Remarks Entities are highly configurable and controllable. All entities are created from a .gltf model asset and allow full control of their rigid body and attached collider dynamics.

Events

This class is an EventRouter, and instances of it emit events with payloads listed under [EntityEventPayloads](./server.entityeventpayloads.md) ## Example ```typescript const spider = new Entity({ name: 'Spider', modelUri: 'models/spider.gltf', modelLoopedAnimations: [ 'walk' ], rigidBodyOptions: { type: RigidBodyType.DYNAMIC, enabledRotations: { x: false, y: true, z: false }, colliders: [ { shape: ColliderShape.ROUND_CYLINDER, borderRadius: 0.1, halfHeight: 0.225, radius: 0.5, tag: 'body', } ], }, }); spider.spawn(world, { x: 20, y: 6, z: 10 }); ``` ## Constructors
Constructor Modifiers Description
[(constructor)(options)](./server.entity._constructor_.md) Constructs a new instance of the `Entity` class
## Properties
Property Modifiers Type Description
[blockHalfExtents](./server.entity.blockhalfextents.md) `readonly` [Vector3Like](./server.vector3like.md) \| undefined The half extends of the visual size of the block entity when blockTextureUri is set.
[blockTextureUri](./server.entity.blocktextureuri.md) `readonly` string \| undefined The URI or path to the texture to be used, if this is set, the entity is a block entity.
[controller](./server.entity.controller.md) `readonly` [BaseEntityController](./server.baseentitycontroller.md) \| undefined The controller for the entity.
[height](./server.entity.height.md) `readonly` number The height of the entity's model or block entity's y\*2 half extents.
[id](./server.entity.id.md) `readonly` number \| undefined The unique identifier for the entity.
[isBlockEntity](./server.entity.isblockentity.md) `readonly` boolean Whether the entity is a block entity.
[isModelEntity](./server.entity.ismodelentity.md) `readonly` boolean Whether the entity is a model entity.
[isSpawned](./server.entity.isspawned.md) `readonly` boolean Whether the entity is spawned.
[modelAnimationsPlaybackRate](./server.entity.modelanimationsplaybackrate.md) `readonly` number The playback rate of the entity's model animations.
[modelHiddenNodes](./server.entity.modelhiddennodes.md) `readonly` ReadonlySet<string> The nodes to hide on the entity's model.
[modelLoopedAnimations](./server.entity.modelloopedanimations.md) `readonly` ReadonlySet<string> The looped animations to start when the entity is spawned.
[modelScale](./server.entity.modelscale.md) `readonly` number \| undefined The scale of the entity's model.
[modelUri](./server.entity.modeluri.md) `readonly` string \| undefined The URI or path to the .gltf model asset to be used for the entity.
[name](./server.entity.name.md) `readonly` string The name of the entity.
[opacity](./server.entity.opacity.md) `readonly` number The opacity of the entity between 0 and 1. 0 is fully transparent, 1 is fully opaque.
[parent](./server.entity.parent.md) `readonly` [Entity](./server.entity.md) \| undefined The parent entity of the entity.
[parentNodeName](./server.entity.parentnodename.md) `readonly` string \| undefined The name of the parent's node (if parent is a model entity) this entity is attached to when spawned.
[tag](./server.entity.tag.md) `readonly` string \| undefined An arbitrary identifier tag of the entity. Useful for your own logic.
[tintColor](./server.entity.tintcolor.md) `readonly` [RgbColor](./server.rgbcolor.md) \| undefined The tint color of the entity.
[world](./server.entity.world.md) `readonly` [World](./server.world.md) \| undefined The world the entity is in.
## Methods
Method Modifiers Description
[despawn()](./server.entity.despawn.md) Despawns the entity and all children from the world.
[setController(controller)](./server.entity.setcontroller.md) Sets the controller for the entity.
[setModelAnimationsPlaybackRate(playbackRate)](./server.entity.setmodelanimationsplaybackrate.md) Sets the playback rate of all animations on the entity's model.
[setModelHiddenNodes(modelHiddenNodes)](./server.entity.setmodelhiddennodes.md) Sets the nodes to hide on the entity's model. Matched nodes will be hidden for all players. Uses case insensitive substring matching.
[setOpacity(opacity)](./server.entity.setopacity.md) Sets the opacity of the entity.
[setParent(parent, parentNodeName, position, rotation)](./server.entity.setparent.md) Sets the parent of the entity and resets this entity's position and rotation.
[setTintColor(tintColor)](./server.entity.settintcolor.md) Sets the tint color of the entity.
[spawn(world, position, rotation)](./server.entity.spawn.md) Spawns the entity in the world.
[startModelLoopedAnimations(animations)](./server.entity.startmodelloopedanimations.md) Starts looped animations for the entity, blending with other animations currently playing.
[startModelOneshotAnimations(animations)](./server.entity.startmodeloneshotanimations.md) Starts a oneshot animation for the entity, blending with other animations currently playing.
[stopModelAnimations(animations)](./server.entity.stopmodelanimations.md) Stops the provided model animations for the entity.