hytopia 0.3.12 → 0.3.13

package/docs/server.baseentityoptions.controller.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; [BaseEntityOptions](./server.baseentityoptions.md) &gt; [controller](./server.baseentityoptions.controller.md)
+
+## BaseEntityOptions.controller property
+
+The entity controller to use for the entity.
+
+**Signature:**
+
+```typescript
+controller?: BaseEntityController;
+```

package/docs/server.baseentityoptions.md

@@ -0,0 +1,190 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityOptions](./server.baseentityoptions.md)
+
+## BaseEntityOptions interface
+
+The base options for an entity.
+
+**Signature:**
+
+```typescript
+export interface BaseEntityOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[controller?](./server.baseentityoptions.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>
+
+[name?](./server.baseentityoptions.name.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The name of the entity.
+
+
+</td></tr>
+<tr><td>
+
+[opacity?](./server.baseentityoptions.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.baseentityoptions.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.baseentityoptions.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.baseentityoptions.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.baseentityoptions.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.baseentityoptions.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.baseentityoptions.name.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; [BaseEntityOptions](./server.baseentityoptions.md) &gt; [name](./server.baseentityoptions.name.md)
+
+## BaseEntityOptions.name property
+
+The name of the entity.
+
+**Signature:**
+
+```typescript
+name?: string;
+```

package/docs/{server.entityoptions.opacity.md → server.baseentityoptions.opacity.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [EntityOptions](./server.entityoptions.md) &gt; [opacity](./server.entityoptions.opacity.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityOptions](./server.baseentityoptions.md) &gt; [opacity](./server.baseentityoptions.opacity.md)
 
-## EntityOptions.opacity property
+## BaseEntityOptions.opacity property
 
 The opacity of the entity between 0 and 1. 0 is fully transparent, 1 is fully opaque.
 

package/docs/{server.entityoptions.parent.md → server.baseentityoptions.parent.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [EntityOptions](./server.entityoptions.md) &gt; [parent](./server.entityoptions.parent.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityOptions](./server.baseentityoptions.md) &gt; [parent](./server.baseentityoptions.parent.md)
 
-## EntityOptions.parent property
+## BaseEntityOptions.parent property
 
 The parent entity of the entity, entities with a parent will ignore creating their own colliders.
 

package/docs/{server.entityoptions.parentnodename.md → server.baseentityoptions.parentnodename.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [EntityOptions](./server.entityoptions.md) &gt; [parentNodeName](./server.entityoptions.parentnodename.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityOptions](./server.baseentityoptions.md) &gt; [parentNodeName](./server.baseentityoptions.parentnodename.md)
 
-## EntityOptions.parentNodeName property
+## BaseEntityOptions.parentNodeName property
 
 The name of the parent's node (if parent is a model entity) to attach the entity to.
 

package/docs/server.baseentityoptions.rigidbodyoptions.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; [BaseEntityOptions](./server.baseentityoptions.md) &gt; [rigidBodyOptions](./server.baseentityoptions.rigidbodyoptions.md)
+
+## BaseEntityOptions.rigidBodyOptions property
+
+The rigid body options for the entity.
+
+**Signature:**
+
+```typescript
+rigidBodyOptions?: RigidBodyOptions;
+```

package/docs/{server.entityoptions.tag.md → server.baseentityoptions.tag.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [EntityOptions](./server.entityoptions.md) &gt; [tag](./server.entityoptions.tag.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityOptions](./server.baseentityoptions.md) &gt; [tag](./server.baseentityoptions.tag.md)
 
-## EntityOptions.tag property
+## BaseEntityOptions.tag property
 
 An arbitrary identifier tag of the entity. Useful for your own logic.
 

package/docs/server.baseentityoptions.tintcolor.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; [BaseEntityOptions](./server.baseentityoptions.md) &gt; [tintColor](./server.baseentityoptions.tintcolor.md)
+
+## BaseEntityOptions.tintColor property
+
+The tint color of the entity as a hex code.
+
+**Signature:**
+
+```typescript
+tintColor?: RgbColor;
+```

package/docs/{server.entityoptions.blockhalfextents.md → server.blockentityoptions.blockhalfextents.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [EntityOptions](./server.entityoptions.md) &gt; [blockHalfExtents](./server.entityoptions.blockhalfextents.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BlockEntityOptions](./server.blockentityoptions.md) &gt; [blockHalfExtents](./server.blockentityoptions.blockhalfextents.md)
 
-## EntityOptions.blockHalfExtents property
+## BlockEntityOptions.blockHalfExtents property
 
 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.
 

package/docs/{server.entityoptions.blocktextureuri.md → server.blockentityoptions.blocktextureuri.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [EntityOptions](./server.entityoptions.md) &gt; [blockTextureUri](./server.entityoptions.blocktextureuri.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BlockEntityOptions](./server.blockentityoptions.md) &gt; [blockTextureUri](./server.blockentityoptions.blocktextureuri.md)
 
-## EntityOptions.blockTextureUri property
+## BlockEntityOptions.blockTextureUri property
 
 The texture uri of a entity if the entity is a block entity, if set rigidBodyOptions collider shape \[0\] must be a block
 

package/docs/server.blockentityoptions.md

@@ -0,0 +1,77 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BlockEntityOptions](./server.blockentityoptions.md)
+
+## BlockEntityOptions interface
+
+The options for creating a block entity.
+
+**Signature:**
+
+```typescript
+export interface BlockEntityOptions 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>
+
+[blockHalfExtents?](./server.blockentityoptions.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.blockentityoptions.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>
+</tbody></table>