hytopia 0.1.37 → 0.1.40

package/docs/server.entity.md

@@ -204,6 +204,48 @@ number \| undefined
 The unique identifier for the entity.
 
 
+</td></tr>
+<tr><td>
+
+[isBlockEntity](./server.entity.isblockentity.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the entity is a block entity.
+
+
+</td></tr>
+<tr><td>
+
+[isModelEntity](./server.entity.ismodelentity.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the entity is a model entity.
+
+
 </td></tr>
 <tr><td>
 
@@ -225,6 +267,27 @@ boolean
 Whether the entity is spawned.
 
 
+</td></tr>
+<tr><td>
+
+[modelHiddenNodes](./server.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>
 
@@ -320,7 +383,7 @@ The name of the entity.
 
 </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) =&gt; void) \| ((entity: [Entity](./server.entity.md)<!-- -->, blockType: [BlockType](./server.blocktype.md)<!-- -->, started: boolean, colliderHandleA: number, colliderHandleB: number) =&gt; void)
 
 
 </td><td>
@@ -377,7 +440,7 @@ _(Optional)_ A function that is called when the entity is despawned.
 
 </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) =&gt; void) \| ((entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, started: boolean, colliderHandleA: number, colliderHandleB: number) =&gt; void)
 
 
 </td><td>
@@ -553,6 +616,20 @@ Despawns the entity from the world.
 Sets the character controller for the entity.
 
 
+</td></tr>
+<tr><td>
+
+[setModelHiddenNodes(modelHiddenNodes)](./server.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>
 

package/docs/server.entity.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; [Entity](./server.entity.md) &gt; [modelHiddenNodes](./server.entity.modelhiddennodes.md)
+
+## Entity.modelHiddenNodes property
+
+The nodes to hide on the entity's model.
+
+**Signature:**
+
+```typescript
+get modelHiddenNodes(): ReadonlySet<string>;
+```

package/docs/server.entity.onblockcollision.md

@@ -9,5 +9,10 @@ A function that is called when the entity collides with a block.
 **Signature:**
 
 ```typescript
-onBlockCollision?: (entity: Entity, blockType: BlockType, started: boolean) => void;
+onBlockCollision?: ((entity: Entity, blockType: BlockType, started: boolean) => void) | ((entity: Entity, blockType: BlockType, started: boolean, colliderHandleA: number, colliderHandleB: number) => void);
 ```
+
+## Remarks
+
+This must be set before the entity is spawned.
+

package/docs/server.entity.onblockcontactforce.md

@@ -11,3 +11,8 @@ A function that is called when the entity collides with a block.
 ```typescript
 onBlockContactForce?: (entity: Entity, blockType: BlockType, contactForceData: ContactForceData) => void;
 ```
+
+## Remarks
+
+This must be set before the entity is spawned.
+

package/docs/server.entity.onentitycollision.md

@@ -9,5 +9,10 @@ A function that is called when the entity collides with another entity.
 **Signature:**
 
 ```typescript
-onEntityCollision?: (entity: Entity, otherEntity: Entity, started: boolean) => void;
+onEntityCollision?: ((entity: Entity, otherEntity: Entity, started: boolean) => void) | ((entity: Entity, otherEntity: Entity, started: boolean, colliderHandleA: number, colliderHandleB: number) => void);
 ```
+
+## Remarks
+
+This must be set before the entity is spawned.
+

package/docs/server.entity.onentitycontactforce.md

@@ -11,3 +11,8 @@ A function that is called when the entity contacts another entity.
 ```typescript
 onEntityContactForce?: (entity: Entity, otherEntity: Entity, contactForceData: ContactForceData) => void;
 ```
+
+## Remarks
+
+This must be set before the entity is spawned.
+

package/docs/server.entity.setmodelhiddennodes.md

@@ -0,0 +1,53 @@
+<!-- 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; [setModelHiddenNodes](./server.entity.setmodelhiddennodes.md)
+
+## Entity.setModelHiddenNodes() method
+
+Sets the nodes to hide on the entity's model. Matched nodes will be hidden for all players. Uses case insensitive substring matching.
+
+**Signature:**
+
+```typescript
+setModelHiddenNodes(modelHiddenNodes: string[]): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+modelHiddenNodes
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+The nodes to hide on the entity's model.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.entity.startmodelloopedanimations.md

@@ -51,3 +51,7 @@ The animations to start.
 
 void
 
+## Remarks
+
+This method will be ignored and do nothing if the entity is a block entity.
+

package/docs/server.entity.startmodeloneshotanimations.md

@@ -51,3 +51,7 @@ The animations to start.
 
 void
 
+## Remarks
+
+This method will be ignored and do nothing if the entity is a block entity.
+

package/docs/server.entity.stopmodelanimations.md

@@ -51,3 +51,7 @@ The animations to stop.
 
 void
 
+## Remarks
+
+This method will be ignored and do nothing if the entity is a block entity.
+

package/docs/server.entityeventpayload.md

@@ -33,6 +33,15 @@ Description
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[SetModelHiddenNodes](./server.entityeventpayload.setmodelhiddennodes.md)
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entityeventpayload.setmodelhiddennodes.entity.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityEventPayload](./server.entityeventpayload.md) &gt; [SetModelHiddenNodes](./server.entityeventpayload.setmodelhiddennodes.md) &gt; [entity](./server.entityeventpayload.setmodelhiddennodes.entity.md)
+
+## EntityEventPayload.SetModelHiddenNodes.entity property
+
+**Signature:**
+
+```typescript
+entity: Entity;
+```

package/docs/server.entityeventpayload.setmodelhiddennodes.md

@@ -0,0 +1,70 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityEventPayload](./server.entityeventpayload.md) &gt; [SetModelHiddenNodes](./server.entityeventpayload.setmodelhiddennodes.md)
+
+## EntityEventPayload.SetModelHiddenNodes interface
+
+**Signature:**
+
+```typescript
+interface SetModelHiddenNodes 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[entity](./server.entityeventpayload.setmodelhiddennodes.entity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[modelHiddenNodes](./server.entityeventpayload.setmodelhiddennodes.modelhiddennodes.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Set&lt;string&gt;
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.entityeventpayload.setmodelhiddennodes.modelhiddennodes.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityEventPayload](./server.entityeventpayload.md) &gt; [SetModelHiddenNodes](./server.entityeventpayload.setmodelhiddennodes.md) &gt; [modelHiddenNodes](./server.entityeventpayload.setmodelhiddennodes.modelhiddennodes.md)
+
+## EntityEventPayload.SetModelHiddenNodes.modelHiddenNodes property
+
+**Signature:**
+
+```typescript
+modelHiddenNodes: Set<string>;
+```

package/docs/server.entityeventtype.md

@@ -43,6 +43,20 @@ DESPAWN
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+SET\_MODEL\_HIDDEN\_NODES
+
+
+</td><td>
+
+`"ENTITY.SET_MODEL_HIDDEN_NODES"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entityoptions.md

@@ -91,6 +91,25 @@ _(Optional)_ The texture uri of a entity if the entity is a block entity, if set
 _(Optional)_ A function that creates a custom character controller for the entity when it spawns.
 
 
+</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>
 

package/docs/server.entityoptions.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; [EntityOptions](./server.entityoptions.md) &gt; [modelHiddenNodes](./server.entityoptions.modelhiddennodes.md)
+
+## EntityOptions.modelHiddenNodes property
+
+The nodes to hide on the entity's model.
+
+**Signature:**
+
+```typescript
+modelHiddenNodes?: string[];
+```

package/docs/server.hytopia.basecharactercontroller.createcolliders.md

@@ -0,0 +1,19 @@
+<!-- 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; [BaseCharacterController](./server.hytopia.basecharactercontroller.md) &gt; [createColliders](./server.hytopia.basecharactercontroller.createcolliders.md)
+
+## HYTOPIA.BaseCharacterController.createColliders() method
+
+Override this method to create controller specific colliders to be attached to the controlled entity when it spawns.
+
+**Signature:**
+
+```typescript
+createColliders(): Collider[];
+```
+**Returns:**
+
+[Collider](./server.collider.md)<!-- -->\[\]
+
+An array of colliders.
+

package/docs/server.hytopia.basecharactercontroller.md

@@ -154,7 +154,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[createSensorColliders()](./server.hytopia.basecharactercontroller.createsensorcolliders.md)
+[createColliders()](./server.hytopia.basecharactercontroller.createcolliders.md)
 
 
 </td><td>
@@ -162,7 +162,7 @@ Description
 
 </td><td>
 
-Override this method to create sensor colliders to be attached to the controlled entity when it spawns.
+Override this method to create controller specific colliders to be attached to the controlled entity when it spawns.
 
 
 </td></tr>

package/docs/server.hytopia.blocktype.md

@@ -183,7 +183,7 @@ The name of the block type.
 
 </td><td>
 
-(blockType: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, started: boolean) =&gt; void
+((blockType: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, started: boolean) =&gt; void) \| ((blockType: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, started: boolean, colliderHandleA: number, colliderHandleB: number) =&gt; void)
 
 
 </td><td>

package/docs/server.hytopia.blocktype.onentitycollision.md

@@ -9,5 +9,10 @@ A callback function that is invoked when an entity collides with blocks of this
 **Signature:**
 
 ```typescript
-onEntityCollision?: (blockType: BlockType, entity: Entity, started: boolean) => void;
+onEntityCollision?: ((blockType: BlockType, entity: Entity, started: boolean) => void) | ((blockType: BlockType, entity: Entity, started: boolean, colliderHandleA: number, colliderHandleB: number) => void);
 ```
+
+## Remarks
+
+This must be set before a block of this type is created. If it is set after a block is created, only future created blocks of this type will have the callback set.
+

package/docs/server.hytopia.blocktype.onentitycontactforce.md

@@ -11,3 +11,8 @@ A callback function that is invoked when an entity contacts a block of this type
 ```typescript
 onEntityContactForce?: (blockType: BlockType, entity: Entity, contactForceData: ContactForceData) => void;
 ```
+
+## Remarks
+
+This must be set before a block of this type is created. If it is set after a block is created, only future created blocks of this type will have the callback set.
+

package/docs/server.hytopia.coefficientcombinerule.md

@@ -0,0 +1,89 @@
+<!-- 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; [CoefficientCombineRule](./server.hytopia.coefficientcombinerule.md)
+
+## HYTOPIA.CoefficientCombineRule enum
+
+The coefficient for friction or bounciness combine rule.
+
+**Signature:**
+
+```typescript
+export declare enum CoefficientCombineRule 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+Average
+
+
+</td><td>
+
+`0`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+Max
+
+
+</td><td>
+
+`3`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+Min
+
+
+</td><td>
+
+`1`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+Multiply
+
+
+</td><td>
+
+`2`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.collider.getbouncinesscombinerule.md

@@ -0,0 +1,19 @@
+<!-- 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; [getBouncinessCombineRule](./server.hytopia.collider.getbouncinesscombinerule.md)
+
+## HYTOPIA.Collider.getBouncinessCombineRule() method
+
+Gets the bounciness combine rule of the collider.
+
+**Signature:**
+
+```typescript
+getBouncinessCombineRule(): CoefficientCombineRule;
+```
+**Returns:**
+
+[CoefficientCombineRule](./server.coefficientcombinerule.md)
+
+The bounciness combine rule of the collider.
+

package/docs/server.hytopia.collider.getfrictioncombinerule.md

@@ -0,0 +1,19 @@
+<!-- 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; [getFrictionCombineRule](./server.hytopia.collider.getfrictioncombinerule.md)
+
+## HYTOPIA.Collider.getFrictionCombineRule() method
+
+Gets the friction combine rule of the collider.
+
+**Signature:**
+
+```typescript
+getFrictionCombineRule(): CoefficientCombineRule;
+```
+**Returns:**
+
+[CoefficientCombineRule](./server.coefficientcombinerule.md)
+
+The friction combine rule of the collider.
+