hytopia 0.1.33 → 0.1.34

package/docs/server.collider.md

@@ -198,6 +198,27 @@ RAPIER.Collider \| undefined
 The raw collider object from the Rapier physics engine.
 
 
+</td></tr>
+<tr><td>
+
+[shape](./server.collider.shape.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[ColliderShape](./server.collidershape.md)
+
+
+</td><td>
+
+The shape of the collider.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.collider.shape.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; [Collider](./server.collider.md) &gt; [shape](./server.collider.shape.md)
+
+## Collider.shape property
+
+The shape of the collider.
+
+**Signature:**
+
+```typescript
+get shape(): ColliderShape;
+```

package/docs/server.default_block_entity_rigid_body_options.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; [DEFAULT\_BLOCK\_ENTITY\_RIGID\_BODY\_OPTIONS](./server.default_block_entity_rigid_body_options.md)
+
+## DEFAULT\_BLOCK\_ENTITY\_RIGID\_BODY\_OPTIONS variable
+
+The default rigid body options for a block entity when EntityOptions.rigidBodyOptions is not provided.
+
+**Signature:**
+
+```typescript
+DEFAULT_BLOCK_ENTITY_RIGID_BODY_OPTIONS: RigidBodyOptions
+```

package/docs/server.default_entity_rigid_body_options.md

@@ -4,7 +4,7 @@
 
 ## DEFAULT\_ENTITY\_RIGID\_BODY\_OPTIONS variable
 
-The default rigid body options when EntityOptions.rigidBodyOptions is not provided.
+The default rigid body options for a model entity when EntityOptions.rigidBodyOptions is not provided.
 
 **Signature:**
 

package/docs/server.entity.blockhalfextents.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; [Entity](./server.entity.md) &gt; [blockHalfExtents](./server.entity.blockhalfextents.md)
+
+## Entity.blockHalfExtents property
+
+The half extends of the visual size of the block entity when blockTextureUri is set.
+
+**Signature:**
+
+```typescript
+get blockHalfExtents(): Vector3 | undefined;
+```

package/docs/server.entity.blocktextureuri.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; [Entity](./server.entity.md) &gt; [blockTextureUri](./server.entity.blocktextureuri.md)
+
+## Entity.blockTextureUri property
+
+The URI or path to the texture to be used, if this is set, the entity is a block entity.
+
+**Signature:**
+
+```typescript
+get blockTextureUri(): string | undefined;
+```

package/docs/server.entity.md

@@ -104,6 +104,48 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[blockHalfExtents](./server.entity.blockhalfextents.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Vector3](./server.vector3.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.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.entity.charactercontroller.md)
 
 
@@ -400,6 +442,27 @@ _(Optional)_ A function that is called when the entity is spawned.
 _(Optional)_ A function that is called every tick.
 
 
+</td></tr>
+<tr><td>
+
+[tag](./server.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>
 

package/docs/server.entity.tag.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; [Entity](./server.entity.md) &gt; [tag](./server.entity.tag.md)
+
+## Entity.tag property
+
+An arbitrary identifier tag of the entity. Useful for your own logic.
+
+**Signature:**
+
+```typescript
+get tag(): string | undefined;
+```

package/docs/server.entitymanager.getentitiesbytag.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityManager](./server.entitymanager.md) &gt; [getEntitiesByTag](./server.entitymanager.getentitiesbytag.md)
+
+## EntityManager.getEntitiesByTag() method
+
+Gets all spawned entities in the world with a specific tag.
+
+**Signature:**
+
+```typescript
+getEntitiesByTag(tag: string): Entity[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+tag
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The tag to get the entities for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Entity](./server.entity.md)<!-- -->\[\]
+
+All spawned entities in the world with the provided tag.
+

package/docs/server.entitymanager.getentitiesbytagsubstring.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityManager](./server.entitymanager.md) &gt; [getEntitiesByTagSubstring](./server.entitymanager.getentitiesbytagsubstring.md)
+
+## EntityManager.getEntitiesByTagSubstring() method
+
+Gets all spawned entities in the world with a tag that includes a specific substring.
+
+**Signature:**
+
+```typescript
+getEntitiesByTagSubstring(tagSubstring: string): Entity[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+tagSubstring
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The tag substring to get the entities for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Entity](./server.entity.md)<!-- -->\[\]
+
+All spawned entities in the world with a tag that includes the provided substring.
+

package/docs/server.entitymanager.md

@@ -118,6 +118,34 @@ Gets all spawned entities in the world.
 Gets all spawned entities in the world assigned to a player.
 
 
+</td></tr>
+<tr><td>
+
+[getEntitiesByTag(tag)](./server.entitymanager.getentitiesbytag.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets all spawned entities in the world with a specific tag.
+
+
+</td></tr>
+<tr><td>
+
+[getEntitiesByTagSubstring(tagSubstring)](./server.entitymanager.getentitiesbytagsubstring.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets all spawned entities in the world with a tag that includes a specific substring.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entityoptions.blockhalfextents.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; [EntityOptions](./server.entityoptions.md) &gt; [blockHalfExtents](./server.entityoptions.blockhalfextents.md)
+
+## EntityOptions.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.
+
+**Signature:**
+
+```typescript
+blockHalfExtents?: Vector3;
+```

package/docs/server.entityoptions.blocktextureuri.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; [EntityOptions](./server.entityoptions.md) &gt; [blockTextureUri](./server.entityoptions.blocktextureuri.md)
+
+## EntityOptions.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
+
+**Signature:**
+
+```typescript
+blockTextureUri?: string;
+```

package/docs/server.entityoptions.md

@@ -37,6 +37,44 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[blockHalfExtents?](./server.entityoptions.blockhalfextents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3](./server.vector3.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>
+
 [createCustomCharacterController?](./server.entityoptions.createcustomcharactercontroller.md)
 
 
@@ -148,5 +186,24 @@ _(Optional)_ The name of the entity.
 _(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>
 </tbody></table>

package/docs/server.entityoptions.tag.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; [EntityOptions](./server.entityoptions.md) &gt; [tag](./server.entityoptions.tag.md)
+
+## EntityOptions.tag property
+
+An arbitrary identifier tag of the entity. Useful for your own logic.
+
+**Signature:**
+
+```typescript
+tag?: string;
+```

package/docs/server.hytopia.collider.md

@@ -198,6 +198,27 @@ RAPIER.Collider \| undefined
 The raw collider object from the Rapier physics engine.
 
 
+</td></tr>
+<tr><td>
+
+[shape](./server.hytopia.collider.shape.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[ColliderShape](./server.collidershape.md)
+
+
+</td><td>
+
+The shape of the collider.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.hytopia.collider.shape.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; [HYTOPIA](./server.hytopia.md) &gt; [Collider](./server.hytopia.collider.md) &gt; [shape](./server.hytopia.collider.shape.md)
+
+## HYTOPIA.Collider.shape property
+
+The shape of the collider.
+
+**Signature:**
+
+```typescript
+get shape(): ColliderShape;
+```

package/docs/server.hytopia.default_block_entity_rigid_body_options.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; [HYTOPIA](./server.hytopia.md) &gt; [DEFAULT\_BLOCK\_ENTITY\_RIGID\_BODY\_OPTIONS](./server.hytopia.default_block_entity_rigid_body_options.md)
+
+## HYTOPIA.DEFAULT\_BLOCK\_ENTITY\_RIGID\_BODY\_OPTIONS variable
+
+The default rigid body options for a block entity when EntityOptions.rigidBodyOptions is not provided.
+
+**Signature:**
+
+```typescript
+DEFAULT_BLOCK_ENTITY_RIGID_BODY_OPTIONS: RigidBodyOptions
+```

package/docs/server.hytopia.default_entity_rigid_body_options.md

@@ -4,7 +4,7 @@
 
 ## HYTOPIA.DEFAULT\_ENTITY\_RIGID\_BODY\_OPTIONS variable
 
-The default rigid body options when EntityOptions.rigidBodyOptions is not provided.
+The default rigid body options for a model entity when EntityOptions.rigidBodyOptions is not provided.
 
 **Signature:**
 

package/docs/server.hytopia.entity.blockhalfextents.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; [HYTOPIA](./server.hytopia.md) &gt; [Entity](./server.hytopia.entity.md) &gt; [blockHalfExtents](./server.hytopia.entity.blockhalfextents.md)
+
+## HYTOPIA.Entity.blockHalfExtents property
+
+The half extends of the visual size of the block entity when blockTextureUri is set.
+
+**Signature:**
+
+```typescript
+get blockHalfExtents(): Vector3 | undefined;
+```

package/docs/server.hytopia.entity.blocktextureuri.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; [HYTOPIA](./server.hytopia.md) &gt; [Entity](./server.hytopia.entity.md) &gt; [blockTextureUri](./server.hytopia.entity.blocktextureuri.md)
+
+## HYTOPIA.Entity.blockTextureUri property
+
+The URI or path to the texture to be used, if this is set, the entity is a block entity.
+
+**Signature:**
+
+```typescript
+get blockTextureUri(): string | undefined;
+```

package/docs/server.hytopia.entity.md

@@ -104,6 +104,48 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[blockHalfExtents](./server.hytopia.entity.blockhalfextents.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Vector3](./server.vector3.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)
 
 
@@ -400,6 +442,27 @@ _(Optional)_ A function that is called when the entity is spawned.
 _(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>
 

package/docs/server.hytopia.entity.tag.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; [HYTOPIA](./server.hytopia.md) &gt; [Entity](./server.hytopia.entity.md) &gt; [tag](./server.hytopia.entity.tag.md)
+
+## HYTOPIA.Entity.tag property
+
+An arbitrary identifier tag of the entity. Useful for your own logic.
+
+**Signature:**
+
+```typescript
+get tag(): string | undefined;
+```

package/docs/server.hytopia.entitymanager.getentitiesbytag.md

@@ -0,0 +1,55 @@
+<!-- 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; [EntityManager](./server.hytopia.entitymanager.md) &gt; [getEntitiesByTag](./server.hytopia.entitymanager.getentitiesbytag.md)
+
+## HYTOPIA.EntityManager.getEntitiesByTag() method
+
+Gets all spawned entities in the world with a specific tag.
+
+**Signature:**
+
+```typescript
+getEntitiesByTag(tag: string): Entity[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+tag
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The tag to get the entities for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Entity](./server.entity.md)<!-- -->\[\]
+
+All spawned entities in the world with the provided tag.
+