hytopia 0.3.12 → 0.3.13

package/docs/server.entityoptions.md

@@ -2,322 +2,14 @@
 
 [Home](./index.md) > [server](./server.md) > [EntityOptions](./server.entityoptions.md)
 
-## EntityOptions interface
+## EntityOptions type
 
-Options for creating an Entity instance.
+The options for creating an Entity instance.
 
 **Signature:**
 
 ```typescript
-export interface EntityOptions 
+export type EntityOptions = BlockEntityOptions | ModelEntityOptions;
 ```
+**References:** [BlockEntityOptions](./server.blockentityoptions.md)<!-- -->, [ModelEntityOptions](./server.modelentityoptions.md)
 
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[blockHalfExtents?](./server.entityoptions.blockhalfextents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[Vector3Like](./server.vector3like.md)
-
-
-</td><td>
-
-_(Optional)_ The half extents of the visual size of the block entity when blockTextureUri is set. If no rigidBodyOptions.colliders are provided, a block collider with the size of the half extents will be created.
-
-
-</td></tr>
-<tr><td>
-
-[blockTextureUri?](./server.entityoptions.blocktextureuri.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ The texture uri of a entity if the entity is a block entity, if set rigidBodyOptions collider shape \[0\] must be a block
-
-
-</td></tr>
-<tr><td>
-
-[controller?](./server.entityoptions.controller.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[BaseEntityController](./server.baseentitycontroller.md)
-
-
-</td><td>
-
-_(Optional)_ The entity controller to use for the entity.
-
-
-</td></tr>
-<tr><td>
-
-[modelAnimationsPlaybackRate?](./server.entityoptions.modelanimationsplaybackrate.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The playback rate of the entity's model animations.
-
-
-</td></tr>
-<tr><td>
-
-[modelHiddenNodes?](./server.entityoptions.modelhiddennodes.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-_(Optional)_ The nodes to hide on the entity's model.
-
-
-</td></tr>
-<tr><td>
-
-[modelLoopedAnimations?](./server.entityoptions.modelloopedanimations.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-_(Optional)_ The looped animations to start when the entity is spawned.
-
-
-</td></tr>
-<tr><td>
-
-[modelScale?](./server.entityoptions.modelscale.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The scale of the entity's model.
-
-
-</td></tr>
-<tr><td>
-
-[modelUri?](./server.entityoptions.modeluri.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ The URI or path to the .gltf model asset to be used for the entity.
-
-
-</td></tr>
-<tr><td>
-
-[name?](./server.entityoptions.name.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ The name of the entity.
-
-
-</td></tr>
-<tr><td>
-
-[opacity?](./server.entityoptions.opacity.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The opacity of the entity between 0 and 1. 0 is fully transparent, 1 is fully opaque.
-
-
-</td></tr>
-<tr><td>
-
-[parent?](./server.entityoptions.parent.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[Entity](./server.entity.md)
-
-
-</td><td>
-
-_(Optional)_ The parent entity of the entity, entities with a parent will ignore creating their own colliders.
-
-
-</td></tr>
-<tr><td>
-
-[parentNodeName?](./server.entityoptions.parentnodename.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ The name of the parent's node (if parent is a model entity) to attach the entity to.
-
-
-</td></tr>
-<tr><td>
-
-[rigidBodyOptions?](./server.entityoptions.rigidbodyoptions.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[RigidBodyOptions](./server.rigidbodyoptions.md)
-
-
-</td><td>
-
-_(Optional)_ The rigid body options for the entity.
-
-
-</td></tr>
-<tr><td>
-
-[tag?](./server.entityoptions.tag.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ An arbitrary identifier tag of the entity. Useful for your own logic.
-
-
-</td></tr>
-<tr><td>
-
-[tintColor?](./server.entityoptions.tintcolor.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[RgbColor](./server.rgbcolor.md)
-
-
-</td><td>
-
-_(Optional)_ The tint color of the entity as a hex code.
-
-
-</td></tr>
-</tbody></table>

package/docs/server.md

@@ -824,6 +824,17 @@ The base options for a collider.
 Event payloads for BaseEntityController emitted events.
 
 
+</td></tr>
+<tr><td>
+
+[BaseEntityOptions](./server.baseentityoptions.md)
+
+
+</td><td>
+
+The base options for an entity.
+
+
 </td></tr>
 <tr><td>
 
@@ -846,6 +857,17 @@ The base options for a rigid body.
 The options for a block collider.
 
 
+</td></tr>
+<tr><td>
+
+[BlockEntityOptions](./server.blockentityoptions.md)
+
+
+</td><td>
+
+The options for creating a block entity.
+
+
 </td></tr>
 <tr><td>
 
@@ -956,17 +978,6 @@ The options for a dynamic rigid body, also the default type.
 Event payloads for Entity emitted events.
 
 
-</td></tr>
-<tr><td>
-
-[EntityOptions](./server.entityoptions.md)
-
-
-</td><td>
-
-Options for creating an Entity instance.
-
-
 </td></tr>
 <tr><td>
 
@@ -1047,45 +1058,45 @@ Options for creating a Light instance.
 </td></tr>
 <tr><td>
 
-[NoneColliderOptions](./server.nonecollideroptions.md)
+[ModelEntityOptions](./server.modelentityoptions.md)
 
 
 </td><td>
 
-The options for an error type "none" collider.
+The options for creating a model entity.
 
 
 </td></tr>
 <tr><td>
 
-[PlayerCameraEventPayloads](./server.playercameraeventpayloads.md)
+[NoneColliderOptions](./server.nonecollideroptions.md)
 
 
 </td><td>
 
-Event payloads for PlayerCamera emitted events.
+The options for an error type "none" collider.
 
 
 </td></tr>
 <tr><td>
 
-[PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md)
+[PlayerCameraEventPayloads](./server.playercameraeventpayloads.md)
 
 
 </td><td>
 
-Options for creating a PlayerEntityController instance.
+Event payloads for PlayerCamera emitted events.
 
 
 </td></tr>
 <tr><td>
 
-[PlayerEntityOptions](./server.playerentityoptions.md)
+[PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md)
 
 
 </td><td>
 
-Options for creating a PlayerEntity instance.
+Options for creating a PlayerEntityController instance.
 
 
 </td></tr>
@@ -1437,6 +1448,17 @@ A contact manifold.
 A decoded set of collision groups represented as their string equivalents.
 
 
+</td></tr>
+<tr><td>
+
+[EntityOptions](./server.entityoptions.md)
+
+
+</td><td>
+
+The options for creating an Entity instance.
+
+
 </td></tr>
 <tr><td>
 
@@ -1547,6 +1569,17 @@ Options for the [PathfindingEntityController.pathfind()](./server.pathfindingent
 The camera orientation state of a Player.
 
 
+</td></tr>
+<tr><td>
+
+[PlayerEntityOptions](./server.playerentityoptions.md)
+
+
+</td><td>
+
+Options for creating a PlayerEntity instance.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.modelentityoptions.md

@@ -0,0 +1,134 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ModelEntityOptions](./server.modelentityoptions.md)
+
+## ModelEntityOptions interface
+
+The options for creating a model entity.
+
+**Signature:**
+
+```typescript
+export interface ModelEntityOptions extends BaseEntityOptions 
+```
+**Extends:** [BaseEntityOptions](./server.baseentityoptions.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[modelAnimationsPlaybackRate?](./server.modelentityoptions.modelanimationsplaybackrate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The playback rate of the entity's model animations.
+
+
+</td></tr>
+<tr><td>
+
+[modelHiddenNodes?](./server.modelentityoptions.modelhiddennodes.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ The nodes to hide on the entity's model.
+
+
+</td></tr>
+<tr><td>
+
+[modelLoopedAnimations?](./server.modelentityoptions.modelloopedanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ The looped animations to start when the entity is spawned.
+
+
+</td></tr>
+<tr><td>
+
+[modelScale?](./server.modelentityoptions.modelscale.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The scale of the entity's model.
+
+
+</td></tr>
+<tr><td>
+
+[modelUri?](./server.modelentityoptions.modeluri.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The URI or path to the .gltf model asset to be used for the entity.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.modelentityoptions.modelanimationsplaybackrate.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ModelEntityOptions](./server.modelentityoptions.md) &gt; [modelAnimationsPlaybackRate](./server.modelentityoptions.modelanimationsplaybackrate.md)
+
+## ModelEntityOptions.modelAnimationsPlaybackRate property
+
+The playback rate of the entity's model animations.
+
+**Signature:**
+
+```typescript
+modelAnimationsPlaybackRate?: number;
+```

package/docs/server.modelentityoptions.modelhiddennodes.md

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

package/docs/server.modelentityoptions.modelloopedanimations.md

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

package/docs/server.modelentityoptions.modelscale.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ModelEntityOptions](./server.modelentityoptions.md) &gt; [modelScale](./server.modelentityoptions.modelscale.md)
+
+## ModelEntityOptions.modelScale property
+
+The scale of the entity's model.
+
+**Signature:**
+
+```typescript
+modelScale?: number;
+```

package/docs/server.modelentityoptions.modeluri.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ModelEntityOptions](./server.modelentityoptions.md) &gt; [modelUri](./server.modelentityoptions.modeluri.md)
+
+## ModelEntityOptions.modelUri property
+
+The URI or path to the .gltf model asset to be used for the entity.
+
+**Signature:**
+
+```typescript
+modelUri?: string;
+```