hytopia 0.1.44 → 0.1.46

package/docs/server.hytopia.entity.md

@@ -1,704 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Entity](./server.hytopia.entity.md)
-
-## HYTOPIA.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.
-
-## 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
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(options)](./server.hytopia.entity._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Constructs a new instance of the `Entity` class
-
-
-</td></tr>
-</tbody></table>
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[blockHalfExtents](./server.hytopia.entity.blockhalfextents.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-[Vector3Like](./server.vector3like.md) \| undefined
-
-
-</td><td>
-
-The half extends of the visual size of the block entity when blockTextureUri is set.
-
-
-</td></tr>
-<tr><td>
-
-[blockTextureUri](./server.hytopia.entity.blocktextureuri.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string \| undefined
-
-
-</td><td>
-
-The URI or path to the texture to be used, if this is set, the entity is a block entity.
-
-
-</td></tr>
-<tr><td>
-
-[characterController](./server.hytopia.entity.charactercontroller.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-[BaseCharacterController](./server.basecharactercontroller.md) \| undefined
-
-
-</td><td>
-
-The character controller for the entity.
-
-
-</td></tr>
-<tr><td>
-
-[createCustomCharacterController?](./server.hytopia.entity.createcustomcharactercontroller.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(entity: [Entity](./server.entity.md)<!-- -->) =&gt; [BaseCharacterController](./server.basecharactercontroller.md)
-
-
-</td><td>
-
-_(Optional)_ A function that creates a custom character controller for the entity when it spawns.
-
-
-</td></tr>
-<tr><td>
-
-[id](./server.hytopia.entity.id.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-number \| undefined
-
-
-</td><td>
-
-The unique identifier for the entity.
-
-
-</td></tr>
-<tr><td>
-
-[isBlockEntity](./server.hytopia.entity.isblockentity.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Whether the entity is a block entity.
-
-
-</td></tr>
-<tr><td>
-
-[isModelEntity](./server.hytopia.entity.ismodelentity.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Whether the entity is a model entity.
-
-
-</td></tr>
-<tr><td>
-
-[isSpawned](./server.hytopia.entity.isspawned.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Whether the entity is spawned.
-
-
-</td></tr>
-<tr><td>
-
-[modelHiddenNodes](./server.hytopia.entity.modelhiddennodes.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-ReadonlySet&lt;string&gt;
-
-
-</td><td>
-
-The nodes to hide on the entity's model.
-
-
-</td></tr>
-<tr><td>
-
-[modelLoopedAnimations](./server.hytopia.entity.modelloopedanimations.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-ReadonlySet&lt;string&gt;
-
-
-</td><td>
-
-The looped animations to start when the entity is spawned.
-
-
-</td></tr>
-<tr><td>
-
-[modelScale](./server.hytopia.entity.modelscale.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-number \| undefined
-
-
-</td><td>
-
-The scale of the entity's model.
-
-
-</td></tr>
-<tr><td>
-
-[modelUri](./server.hytopia.entity.modeluri.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string \| undefined
-
-
-</td><td>
-
-The URI or path to the .gltf model asset to be used for the entity.
-
-
-</td></tr>
-<tr><td>
-
-[name](./server.hytopia.entity.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The name of the entity.
-
-
-</td></tr>
-<tr><td>
-
-[onBlockCollision?](./server.hytopia.entity.onblockcollision.md)
-
-
-</td><td>
-
-
-</td><td>
-
-((entity: [Entity](./server.entity.md)<!-- -->, blockType: [BlockType](./server.blocktype.md)<!-- -->, started: boolean) =&gt; void) \| ((entity: [Entity](./server.entity.md)<!-- -->, blockType: [BlockType](./server.blocktype.md)<!-- -->, started: boolean, colliderHandleA: number, colliderHandleB: number) =&gt; void)
-
-
-</td><td>
-
-_(Optional)_ A function that is called when the entity collides with a block.
-
-
-</td></tr>
-<tr><td>
-
-[onBlockContactForce?](./server.hytopia.entity.onblockcontactforce.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(entity: [Entity](./server.entity.md)<!-- -->, blockType: [BlockType](./server.blocktype.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ A function that is called when the entity collides with a block.
-
-
-</td></tr>
-<tr><td>
-
-[onDespawn?](./server.hytopia.entity.ondespawn.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ A function that is called when the entity is despawned.
-
-
-</td></tr>
-<tr><td>
-
-[onEntityCollision?](./server.hytopia.entity.onentitycollision.md)
-
-
-</td><td>
-
-
-</td><td>
-
-((entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, started: boolean) =&gt; void) \| ((entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, started: boolean, colliderHandleA: number, colliderHandleB: number) =&gt; void)
-
-
-</td><td>
-
-_(Optional)_ A function that is called when the entity collides with another entity.
-
-
-</td></tr>
-<tr><td>
-
-[onEntityContactForce?](./server.hytopia.entity.onentitycontactforce.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ A function that is called when the entity contacts another entity.
-
-
-</td></tr>
-<tr><td>
-
-[onSpawn?](./server.hytopia.entity.onspawn.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ A function that is called when the entity is spawned.
-
-
-</td></tr>
-<tr><td>
-
-[onTick?](./server.hytopia.entity.ontick.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(entity: [Entity](./server.entity.md)<!-- -->, tickDeltaMs: number) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ A function that is called every tick.
-
-
-</td></tr>
-<tr><td>
-
-[tag](./server.hytopia.entity.tag.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string \| undefined
-
-
-</td><td>
-
-An arbitrary identifier tag of the entity. Useful for your own logic.
-
-
-</td></tr>
-<tr><td>
-
-[tintColor](./server.hytopia.entity.tintcolor.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-[RgbColor](./server.rgbcolor.md) \| undefined
-
-
-</td><td>
-
-The tint color of the entity.
-
-
-</td></tr>
-<tr><td>
-
-[world](./server.hytopia.entity.world.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-[World](./server.world.md) \| undefined
-
-
-</td><td>
-
-The world the entity is in.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[despawn()](./server.hytopia.entity.despawn.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Despawns the entity from the world.
-
-
-</td></tr>
-<tr><td>
-
-[setCharacterController(characterController)](./server.hytopia.entity.setcharactercontroller.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Sets the character controller for the entity.
-
-
-</td></tr>
-<tr><td>
-
-[setModelHiddenNodes(modelHiddenNodes)](./server.hytopia.entity.setmodelhiddennodes.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Sets the nodes to hide on the entity's model. Matched nodes will be hidden for all players. Uses case insensitive substring matching.
-
-
-</td></tr>
-<tr><td>
-
-[setTintColor(tintColor)](./server.hytopia.entity.settintcolor.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Sets the tint color of the entity.
-
-
-</td></tr>
-<tr><td>
-
-[spawn(world, coordinate)](./server.hytopia.entity.spawn.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Spawns the entity in the world.
-
-
-</td></tr>
-<tr><td>
-
-[startModelLoopedAnimations(animations)](./server.hytopia.entity.startmodelloopedanimations.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Starts looped animations for the entity, blending with other animations currently playing.
-
-
-</td></tr>
-<tr><td>
-
-[startModelOneshotAnimations(animations)](./server.hytopia.entity.startmodeloneshotanimations.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Starts a oneshot animation for the entity, blending with other animations currently playing.
-
-
-</td></tr>
-<tr><td>
-
-[stopModelAnimations(animations)](./server.hytopia.entity.stopmodelanimations.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Stops the provided model animations for the entity.
-
-
-</td></tr>
-</tbody></table>

package/docs/server.hytopia.entity.modelhiddennodes.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Entity](./server.hytopia.entity.md) &gt; [modelHiddenNodes](./server.hytopia.entity.modelhiddennodes.md)
-
-## HYTOPIA.Entity.modelHiddenNodes property
-
-The nodes to hide on the entity's model.
-
-**Signature:**
-
-```typescript
-get modelHiddenNodes(): ReadonlySet<string>;
-```

package/docs/server.hytopia.entity.modelloopedanimations.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Entity](./server.hytopia.entity.md) &gt; [modelLoopedAnimations](./server.hytopia.entity.modelloopedanimations.md)
-
-## HYTOPIA.Entity.modelLoopedAnimations property
-
-The looped animations to start when the entity is spawned.
-
-**Signature:**
-
-```typescript
-get modelLoopedAnimations(): ReadonlySet<string>;
-```