[Home](./index.md) > [server](./server.md) > [Entity](./server.entity.md) ## Entity class Represents a dynamic or static object in a world. When to use: any non-player object that needs physics, visuals, or interactions. Do NOT use for: player-controlled avatars (use `PlayerEntity` / `DefaultPlayerEntity`). Do NOT use for: voxel blocks (use block APIs on `ChunkLattice`). **Signature:** ```typescript export default class Entity extends RigidBody implements protocol.Serializable ``` **Extends:** [RigidBody](./server.rigidbody.md) **Implements:** protocol.Serializable ## Remarks Entities are created from a block texture or a `.gltf` model and can have rigid bodies, colliders, animations, and controllers.

Coordinate System

HYTOPIA uses a right-handed coordinate system where: - \*\*+X\*\* is right - \*\*+Y\*\* is up - \*\*-Z\*\* is forward (identity orientation) Models should be authored with their front/forward facing the \*\*-Z axis\*\*. When an entity has identity rotation (0,0,0,1 quaternion or yaw=0), it faces -Z.

Events

This class is an EventRouter, and instances of it emit events with payloads listed under `EntityEventPayloads`. ## Example ```typescript const spider = new Entity({ name: 'Spider', modelUri: 'models/spider.gltf', 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 }); ``` \*\*Category:\*\* Entities ## Constructors
Constructor Modifiers Description
[(constructor)(options)](./server.entity._constructor_.md) Creates a new Entity instance. Use for: defining a new entity before spawning it into a world. Do NOT use for: player-controlled avatars (use `PlayerEntity` or `DefaultPlayerEntity`).
## Properties
Property Modifiers Type Description
[availableModelAnimationNames](./server.entity.availablemodelanimationnames.md) `readonly` Readonly<string\[\]> The names of the animations available in the entity's model. \*\*Category:\*\* Entities
[availableModelNodeNames](./server.entity.availablemodelnodenames.md) `readonly` Readonly<string\[\]> The names of the nodes available in the entity's model. \*\*Category:\*\* Entities
[blockHalfExtents](./server.entity.blockhalfextents.md) `readonly` [Vector3Like](./server.vector3like.md) \| undefined The half extents of the block entity's visual size.
[blockTextureUri](./server.entity.blocktextureuri.md) `readonly` string \| undefined The texture URI for block entities.
[controller](./server.entity.controller.md) `readonly` [BaseEntityController](./server.baseentitycontroller.md) \| undefined The controller for the entity. \*\*Category:\*\* Entities
[depth](./server.entity.depth.md) `readonly` number The depth (Z-axis) of the entity's model or block size. \*\*Category:\*\* Entities
[emissiveColor](./server.entity.emissivecolor.md) `readonly` [RgbColor](./server.rgbcolor.md) \| undefined The emissive color of the entity. \*\*Category:\*\* Entities
[emissiveIntensity](./server.entity.emissiveintensity.md) `readonly` number \| undefined The emissive intensity of the entity. \*\*Category:\*\* Entities
[height](./server.entity.height.md) `readonly` number The height (Y-axis) of the entity's model or block size. \*\*Category:\*\* Entities
[id](./server.entity.id.md) `readonly` number \| undefined The unique identifier for the entity.
[isBlockEntity](./server.entity.isblockentity.md) `readonly` boolean Whether this entity is a block entity. \*\*Category:\*\* Entities
[isEnvironmental](./server.entity.isenvironmental.md) `readonly` boolean Whether the entity is environmental.
[isModelEntity](./server.entity.ismodelentity.md) `readonly` boolean Whether this entity is a model entity. \*\*Category:\*\* Entities
[isSpawned](./server.entity.isspawned.md) `readonly` boolean Whether the entity is spawned in a world. \*\*Category:\*\* Entities
[modelAnimations](./server.entity.modelanimations.md) `readonly` Readonly<[EntityModelAnimation](./server.entitymodelanimation.md)\[\]> The animations of the entity's model that have been accessed or configured.
[modelNodeOverrides](./server.entity.modelnodeoverrides.md) `readonly` Readonly<[EntityModelNodeOverride](./server.entitymodelnodeoverride.md)\[\]> The node overrides of the entity's model that have been accessed or configured.
[modelPreferredShape](./server.entity.modelpreferredshape.md) `readonly` [ColliderShape](./server.collidershape.md) \| undefined The preferred collider shape when auto-generating colliders from the model. \*\*Category:\*\* Entities
[modelScale](./server.entity.modelscale.md) `readonly` [Vector3Like](./server.vector3like.md) The scale of the entity's model. \*\*Category:\*\* Entities
[modelScaleInterpolationMs](./server.entity.modelscaleinterpolationms.md) `readonly` number \| undefined The interpolation time in milliseconds applied to model scale changes. \*\*Category:\*\* Entities
[modelTextureUri](./server.entity.modeltextureuri.md) `readonly` string \| undefined The texture URI that overrides the model entity's default texture. \*\*Category:\*\* Entities
[modelUri](./server.entity.modeluri.md) `readonly` string \| undefined The URI or path to the `.gltf` model asset. \*\*Category:\*\* Entities
[name](./server.entity.name.md) `readonly` string The name of the entity. \*\*Category:\*\* Entities
[opacity](./server.entity.opacity.md) `readonly` number The opacity of the entity between 0 and 1. \*\*Category:\*\* Entities
[outline](./server.entity.outline.md) `readonly` [Outline](./server.outline.md) \| undefined The outline rendering options for the entity. \*\*Category:\*\* Entities
[parent](./server.entity.parent.md) `readonly` [Entity](./server.entity.md) \| undefined The parent entity, if attached. \*\*Category:\*\* Entities
[parentNodeName](./server.entity.parentnodename.md) `readonly` string \| undefined The parent model node name, if attached. \*\*Category:\*\* Entities
[positionInterpolationMs](./server.entity.positioninterpolationms.md) `readonly` number \| undefined The interpolation time in milliseconds applied to position changes. \*\*Category:\*\* Entities
[rotationInterpolationMs](./server.entity.rotationinterpolationms.md) `readonly` number \| undefined The interpolation time in milliseconds applied to rotation changes. \*\*Category:\*\* Entities
[tag](./server.entity.tag.md) `readonly` string \| undefined An arbitrary identifier tag for your own logic. \*\*Category:\*\* Entities
[tintColor](./server.entity.tintcolor.md) `readonly` [RgbColor](./server.rgbcolor.md) \| undefined The tint color of the entity. \*\*Category:\*\* Entities
[width](./server.entity.width.md) `readonly` number The width (X-axis) of the entity's model or block size. \*\*Category:\*\* Entities
[world](./server.entity.world.md) `readonly` [World](./server.world.md) \| undefined The world the entity is in, if spawned. \*\*Category:\*\* Entities
## Methods
Method Modifiers Description
[clearModelNodeOverrides()](./server.entity.clearmodelnodeoverrides.md) Clears all model node overrides from the entity's model. \*\*Category:\*\* Entities
[despawn()](./server.entity.despawn.md) Despawns the entity and all children from the world. Use for: removing entities from the world. Do NOT use for: temporary hiding; consider visibility or animations instead.
[getModelAnimation(name)](./server.entity.getmodelanimation.md) Gets or lazily creates a model animation for the entity's model by name.
[getModelNodeOverride(nameMatch)](./server.entity.getmodelnodeoverride.md) Gets or lazily creates a model node override for the entity's model.
[interact(player, raycastHit)](./server.entity.interact.md) Triggers an interaction on the entity from a player. Use for: programmatic interactions that should mimic a player click/tap. Do NOT use for: server-only effects without player context.
[removeModelNodeOverride(nameMatch)](./server.entity.removemodelnodeoverride.md) Removes a model node override from the entity's model.
[removeModelNodeOverrides(nameMatches)](./server.entity.removemodelnodeoverrides.md) Removes multiple model node overrides from the entity's model.
[setBlockTextureUri(blockTextureUri)](./server.entity.setblocktextureuri.md)
[setEmissiveColor(emissiveColor)](./server.entity.setemissivecolor.md) Sets the emissive color of the entity. Use for: glow effects or highlighted states.
[setEmissiveIntensity(emissiveIntensity)](./server.entity.setemissiveintensity.md) Sets the emissive intensity of the entity.
[setModelScale(modelScale)](./server.entity.setmodelscale.md) Sets the scale of the entity's model and proportionally scales its colliders.
[setModelScaleInterpolationMs(interpolationMs)](./server.entity.setmodelscaleinterpolationms.md) Sets the interpolation time in milliseconds applied to model scale changes.
[setModelTextureUri(modelTextureUri)](./server.entity.setmodeltextureuri.md) Sets the texture uri of the entity's model. Setting this overrides the model's default texture.
[setOpacity(opacity)](./server.entity.setopacity.md) Sets the opacity of the entity.
[setOutline(outline, forPlayer)](./server.entity.setoutline.md) Sets the outline rendering options for 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.
[setPositionInterpolationMs(interpolationMs)](./server.entity.setpositioninterpolationms.md) Sets the interpolation time in milliseconds applied to position changes.
[setRotationInterpolationMs(interpolationMs)](./server.entity.setrotationinterpolationms.md) Sets the interpolation time in milliseconds applied to rotation changes.
[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. Use for: placing the entity into a world so it simulates and syncs to clients. Do NOT use for: reusing a single entity instance across multiple worlds.
[stopAllModelAnimations(exclusionFilter)](./server.entity.stopallmodelanimations.md) Stops all model animations for the entity, optionally excluding the provided animations from stopping.
[stopModelAnimations(modelAnimationNames)](./server.entity.stopmodelanimations.md) Stops the provided model animations for the entity.