hytopia 0.1.0 → 0.1.2

package/docs/server.hytopia.collisiongroup.md

@@ -0,0 +1,116 @@
+<!-- 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; [CollisionGroup](./server.hytopia.collisiongroup.md)
+
+## HYTOPIA.CollisionGroup enum
+
+The default collision groups.
+
+**Signature:**
+
+```typescript
+export declare enum CollisionGroup 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+ALL
+
+
+</td><td>
+
+`65535`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+BLOCK
+
+
+</td><td>
+
+`1`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+ENTITY
+
+
+</td><td>
+
+`2`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+ENTITY\_SENSOR
+
+
+</td><td>
+
+`4`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+PLAYER
+
+
+</td><td>
+
+`8`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+## Remarks
+
+The collision groups are used to determine which objects collide and generate collision and contact force events. The default collision groups can be used for most entity and block interactions, but you may want to create your own for more complex scenarios. Up to 15 collision groups can be registered. Collision groups use pairwise filtering using bit masks.
+
+This filtering method is based on two 16-bit values: - The belongsTo groups (the 16 left-most bits of `self.0`<!-- -->). - The collidesWith mask (the 16 right-most bits of `self.0`<!-- -->).
+
+An interaction is allowed between two filters `a` and `b` two conditions are met simultaneously: - The belongsTo groups of `a` has at least one bit set to `1` in common with the collidesWith mask of `b`<!-- -->. - The belongsTo groups of `b` has at least one bit set to `1` in common with the collidesWith mask of `a`<!-- -->. In other words, interactions are allowed between two filter if the following condition is met:
+
+```
+((a >> 16) & b) != 0 && ((b >> 16) & a) != 0
+```
+

package/docs/server.hytopia.collisiongroups.md

@@ -0,0 +1,18 @@
+<!-- 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; [CollisionGroups](./server.hytopia.collisiongroups.md)
+
+## HYTOPIA.CollisionGroups type
+
+A set of collision groups.
+
+**Signature:**
+
+```typescript
+export type CollisionGroups = {
+    belongsTo: CollisionGroup[];
+    collidesWith: CollisionGroup[];
+};
+```
+**References:** [CollisionGroup](./server.collisiongroup.md)
+

package/docs/server.hytopia.collisiongroupsbuilder.buildrawcollisiongroups.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; [CollisionGroupsBuilder](./server.hytopia.collisiongroupsbuilder.md) &gt; [buildRawCollisionGroups](./server.hytopia.collisiongroupsbuilder.buildrawcollisiongroups.md)
+
+## HYTOPIA.CollisionGroupsBuilder.buildRawCollisionGroups() method
+
+Builds a raw set of collision groups from a set of collision groups.
+
+**Signature:**
+
+```typescript
+static buildRawCollisionGroups(collisionGroups: CollisionGroups): RawCollisionGroups;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+collisionGroups
+
+
+</td><td>
+
+[CollisionGroups](./server.collisiongroups.md)
+
+
+</td><td>
+
+The set of collision groups to build.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[RawCollisionGroups](./server.rawcollisiongroups.md)
+
+A raw set of collision groups represented as a 32-bit number.
+

package/docs/server.hytopia.collisiongroupsbuilder.decodecollisiongroups.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; [CollisionGroupsBuilder](./server.hytopia.collisiongroupsbuilder.md) &gt; [decodeCollisionGroups](./server.hytopia.collisiongroupsbuilder.decodecollisiongroups.md)
+
+## HYTOPIA.CollisionGroupsBuilder.decodeCollisionGroups() method
+
+Decodes a set of collision groups into a set of their string equivalents.
+
+**Signature:**
+
+```typescript
+static decodeCollisionGroups(collisionGroups: CollisionGroups): DecodedCollisionGroups;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+collisionGroups
+
+
+</td><td>
+
+[CollisionGroups](./server.collisiongroups.md)
+
+
+</td><td>
+
+The set of collision groups to decode.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[DecodedCollisionGroups](./server.decodedcollisiongroups.md)
+
+A set of collision groups represented as their string equivalents.
+

package/docs/server.hytopia.collisiongroupsbuilder.decoderawcollisiongroups.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; [CollisionGroupsBuilder](./server.hytopia.collisiongroupsbuilder.md) &gt; [decodeRawCollisionGroups](./server.hytopia.collisiongroupsbuilder.decoderawcollisiongroups.md)
+
+## HYTOPIA.CollisionGroupsBuilder.decodeRawCollisionGroups() method
+
+Decodes a raw set of collision groups into a set of collision groups.
+
+**Signature:**
+
+```typescript
+static decodeRawCollisionGroups(groups: RawCollisionGroups): CollisionGroups;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+groups
+
+
+</td><td>
+
+[RawCollisionGroups](./server.rawcollisiongroups.md)
+
+
+</td><td>
+
+The raw set of collision groups to decode.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[CollisionGroups](./server.collisiongroups.md)
+
+A set of collision groups.
+

package/docs/server.hytopia.collisiongroupsbuilder.isdefaultcollisiongroups.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; [CollisionGroupsBuilder](./server.hytopia.collisiongroupsbuilder.md) &gt; [isDefaultCollisionGroups](./server.hytopia.collisiongroupsbuilder.isdefaultcollisiongroups.md)
+
+## HYTOPIA.CollisionGroupsBuilder.isDefaultCollisionGroups() method
+
+Checks if the collision groups are the default collision groups.
+
+**Signature:**
+
+```typescript
+static isDefaultCollisionGroups(collisionGroups: CollisionGroups): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+collisionGroups
+
+
+</td><td>
+
+[CollisionGroups](./server.collisiongroups.md)
+
+
+</td><td>
+
+The set of collision groups to check.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+boolean
+
+Whether the collision groups are the default collision groups.
+

package/docs/server.hytopia.collisiongroupsbuilder.md

@@ -0,0 +1,101 @@
+<!-- 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; [CollisionGroupsBuilder](./server.hytopia.collisiongroupsbuilder.md)
+
+## HYTOPIA.CollisionGroupsBuilder class
+
+A helper class for building and decoding collision groups.
+
+**Signature:**
+
+```typescript
+export default class CollisionGroupsBuilder 
+```
+
+## Remarks
+
+This class should be used directly with its static methods. You can assign collision groups to colliders of entities and blocks to control optimized collision interactions and filterings between blocks and entities, and entities and other entities.
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[buildRawCollisionGroups(collisionGroups)](./server.hytopia.collisiongroupsbuilder.buildrawcollisiongroups.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Builds a raw set of collision groups from a set of collision groups.
+
+
+</td></tr>
+<tr><td>
+
+[decodeCollisionGroups(collisionGroups)](./server.hytopia.collisiongroupsbuilder.decodecollisiongroups.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Decodes a set of collision groups into a set of their string equivalents.
+
+
+</td></tr>
+<tr><td>
+
+[decodeRawCollisionGroups(groups)](./server.hytopia.collisiongroupsbuilder.decoderawcollisiongroups.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Decodes a raw set of collision groups into a set of collision groups.
+
+
+</td></tr>
+<tr><td>
+
+[isDefaultCollisionGroups(collisionGroups)](./server.hytopia.collisiongroupsbuilder.isdefaultcollisiongroups.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Checks if the collision groups are the default collision groups.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.commandcallback.md

@@ -0,0 +1,15 @@
+<!-- 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; [CommandCallback](./server.hytopia.commandcallback.md)
+
+## HYTOPIA.CommandCallback type
+
+A callback function for a chat command.
+
+**Signature:**
+
+```typescript
+export type CommandCallback = (player: Player, args: string[], message: string) => void;
+```
+**References:** [Player](./server.player.md)
+

package/docs/server.hytopia.decodedcollisiongroups.md

@@ -0,0 +1,16 @@
+<!-- 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; [DecodedCollisionGroups](./server.hytopia.decodedcollisiongroups.md)
+
+## HYTOPIA.DecodedCollisionGroups type
+
+A decoded set of collision groups represented as their string equivalents.
+
+**Signature:**
+
+```typescript
+export type DecodedCollisionGroups = {
+    belongsTo: string[];
+    collidesWith: string[];
+};
+```

package/docs/server.hytopia.default_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\_ENTITY\_RIGID\_BODY\_OPTIONS](./server.hytopia.default_entity_rigid_body_options.md)
+
+## HYTOPIA.DEFAULT\_ENTITY\_RIGID\_BODY\_OPTIONS variable
+
+The default rigid body options when EntityOptions.rigidBodyOptions is not provided.
+
+**Signature:**
+
+```typescript
+DEFAULT_ENTITY_RIGID_BODY_OPTIONS: RigidBodyOptions
+```

package/docs/server.hytopia.defaultcharactercontroller._constructor_.md

@@ -0,0 +1,65 @@
+<!-- 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; [DefaultCharacterController](./server.hytopia.defaultcharactercontroller.md) &gt; [(constructor)](./server.hytopia.defaultcharactercontroller._constructor_.md)
+
+## HYTOPIA.DefaultCharacterController.(constructor)
+
+Constructs a new instance of the `DefaultCharacterController` class
+
+**Signature:**
+
+```typescript
+constructor(entity: Entity, options?: DefaultCharacterControllerOptions);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+entity
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+The entity the controller is for.
+
+
+</td></tr>
+<tr><td>
+
+options
+
+
+</td><td>
+
+[DefaultCharacterControllerOptions](./server.defaultcharactercontrolleroptions.md)
+
+
+</td><td>
+
+_(Optional)_ Options for the controller.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.defaultcharactercontroller.canjump.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; [DefaultCharacterController](./server.hytopia.defaultcharactercontroller.md) &gt; [canJump](./server.hytopia.defaultcharactercontroller.canjump.md)
+
+## HYTOPIA.DefaultCharacterController.canJump property
+
+A function allowing custom logic to determine if the entity can jump.
+
+**Signature:**
+
+```typescript
+canJump: (this: DefaultCharacterController) => boolean;
+```

package/docs/server.hytopia.defaultcharactercontroller.canrun.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; [DefaultCharacterController](./server.hytopia.defaultcharactercontroller.md) &gt; [canRun](./server.hytopia.defaultcharactercontroller.canrun.md)
+
+## HYTOPIA.DefaultCharacterController.canRun property
+
+A function allowing custom logic to determine if the entity can run.
+
+**Signature:**
+
+```typescript
+canRun: (this: DefaultCharacterController) => boolean;
+```

package/docs/server.hytopia.defaultcharactercontroller.canwalk.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; [DefaultCharacterController](./server.hytopia.defaultcharactercontroller.md) &gt; [canWalk](./server.hytopia.defaultcharactercontroller.canwalk.md)
+
+## HYTOPIA.DefaultCharacterController.canWalk property
+
+A function allowing custom logic to determine if the entity can walk.
+
+**Signature:**
+
+```typescript
+canWalk: (this: DefaultCharacterController) => boolean;
+```

package/docs/server.hytopia.defaultcharactercontroller.createsensorcolliders.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; [DefaultCharacterController](./server.hytopia.defaultcharactercontroller.md) &gt; [createSensorColliders](./server.hytopia.defaultcharactercontroller.createsensorcolliders.md)
+
+## HYTOPIA.DefaultCharacterController.createSensorColliders() method
+
+Creates the sensor colliders for the character controller, overriding the default implementation.
+
+**Signature:**
+
+```typescript
+createSensorColliders(): Collider[];
+```
+**Returns:**
+
+[Collider](./server.collider.md)<!-- -->\[\]
+
+An array of colliders.
+

package/docs/server.hytopia.defaultcharactercontroller.isgrounded.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; [DefaultCharacterController](./server.hytopia.defaultcharactercontroller.md) &gt; [isGrounded](./server.hytopia.defaultcharactercontroller.isgrounded.md)
+
+## HYTOPIA.DefaultCharacterController.isGrounded property
+
+Whether the entity is grounded.
+
+**Signature:**
+
+```typescript
+get isGrounded(): boolean;
+```

package/docs/server.hytopia.defaultcharactercontroller.isonplatform.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; [DefaultCharacterController](./server.hytopia.defaultcharactercontroller.md) &gt; [isOnPlatform](./server.hytopia.defaultcharactercontroller.isonplatform.md)
+
+## HYTOPIA.DefaultCharacterController.isOnPlatform property
+
+Whether the entity is on a platform, a platform is any entity with a kinematic rigid body.
+
+**Signature:**
+
+```typescript
+get isOnPlatform(): boolean;
+```

package/docs/server.hytopia.defaultcharactercontroller.jumpvelocity.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; [DefaultCharacterController](./server.hytopia.defaultcharactercontroller.md) &gt; [jumpVelocity](./server.hytopia.defaultcharactercontroller.jumpvelocity.md)
+
+## HYTOPIA.DefaultCharacterController.jumpVelocity property
+
+The upward velocity applied to the entity when it jumps.
+
+**Signature:**
+
+```typescript
+jumpVelocity: number;
+```