npm - hytopia - Versions diffs - 0.1.44 → 0.1.45 - Mend

hytopia 0.1.44 → 0.1.45

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (714) hide show

package/docs/server.hytopia.md DELETED Viewed

@@ -1,1047 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md)
-## HYTOPIA namespace
-## Classes
-<table><thead><tr><th>
-Class
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[Audio](./server.hytopia.audio.md)
-</td><td>
-Represents a audio playback in a world.
-</td></tr>
-<tr><td>
-[AudioManager](./server.hytopia.audiomanager.md)
-</td><td>
-Manages audio instances in a world.
-</td></tr>
-<tr><td>
-[Block](./server.hytopia.block.md)
-</td><td>
-Represents a block in a world.
-</td></tr>
-<tr><td>
-[BlockType](./server.hytopia.blocktype.md)
-</td><td>
-Represents a block type.
-</td></tr>
-<tr><td>
-[BlockTypeRegistry](./server.hytopia.blocktyperegistry.md)
-</td><td>
-Manages known block types in a world.
-</td></tr>
-<tr><td>
-[ChatManager](./server.hytopia.chatmanager.md)
-</td><td>
-Manages chat and commands in a world.
-</td></tr>
-<tr><td>
-[Chunk](./server.hytopia.chunk.md)
-</td><td>
-A 16^3 chunk of blocks. Used to represent a world's terrain.
-</td></tr>
-<tr><td>
-[ChunkLattice](./server.hytopia.chunklattice.md)
-</td><td>
-A lattice of chunks that represent a world's terrain.
-</td></tr>
-<tr><td>
-[Collider](./server.hytopia.collider.md)
-</td><td>
-Represents a collider in a world's physics simulation.
-</td></tr>
-<tr><td>
-[CollisionGroupsBuilder](./server.hytopia.collisiongroupsbuilder.md)
-</td><td>
-A helper class for building and decoding collision groups.
-</td></tr>
-<tr><td>
-[DefaultCharacterController](./server.hytopia.defaultcharactercontroller.md)
-</td><td>
-The default character controller implementation.
-</td></tr>
-<tr><td>
-[Entity](./server.hytopia.entity.md)
-</td><td>
-Represents an entity in a world.
-</td></tr>
-<tr><td>
-[EntityManager](./server.hytopia.entitymanager.md)
-</td><td>
-Manages entities in a world.
-</td></tr>
-<tr><td>
-[EventRouter](./server.hytopia.eventrouter.md)
-</td><td>
-Manages event emission and assigned listener callbacks.
-</td></tr>
-<tr><td>
-[GameServer](./server.hytopia.gameserver.md)
-</td><td>
-Manages the game and associated worlds and systems.
-</td></tr>
-<tr><td>
-[Player](./server.hytopia.player.md)
-</td><td>
-A player in the game.
-</td></tr>
-<tr><td>
-[PlayerCamera](./server.hytopia.playercamera.md)
-</td><td>
-The camera for a Player.
-</td></tr>
-<tr><td>
-[PlayerEntity](./server.hytopia.playerentity.md)
-</td><td>
-Represents an entity controlled by a player in a world.
-</td></tr>
-<tr><td>
-[PlayerManager](./server.hytopia.playermanager.md)
-</td><td>
-Manages all connected players in a game server.
-</td></tr>
-<tr><td>
-[Quaternion](./server.hytopia.quaternion.md)
-</td><td>
-Represents a quaternion.
-</td></tr>
-<tr><td>
-[RigidBody](./server.hytopia.rigidbody.md)
-</td><td>
-Represents a rigid body in a world's physics simulation.
-</td></tr>
-<tr><td>
-[SimpleCharacterController](./server.hytopia.simplecharactercontroller.md)
-</td><td>
-A simple character controller with basic movement functions.
-</td></tr>
-<tr><td>
-[Simulation](./server.hytopia.simulation.md)
-</td><td>
-Represents the physics simulation for a world.
-</td></tr>
-<tr><td>
-[Vector3](./server.hytopia.vector3.md)
-</td><td>
-Represents a 3-dimensional vector.
-</td></tr>
-<tr><td>
-[World](./server.hytopia.world.md)
-</td><td>
-Represents a world in the game server.
-</td></tr>
-<tr><td>
-[WorldLoop](./server.hytopia.worldloop.md)
-</td><td>
-Manages the tick loop for a world.
-</td></tr>
-</tbody></table>
-## Abstract Classes
-<table><thead><tr><th>
-Abstract Class
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[BaseCharacterController](./server.hytopia.basecharactercontroller.md)
-</td><td>
-A base class for character controller implementations.
-</td></tr>
-</tbody></table>
-## Enumerations
-<table><thead><tr><th>
-Enumeration
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[AudioEventType](./server.hytopia.audioeventtype.md)
-</td><td>
-Event types an Audio instance can emit.
-</td></tr>
-<tr><td>
-[BlockTypeRegistryEventType](./server.hytopia.blocktyperegistryeventtype.md)
-</td><td>
-Event types a BlockTypeRegistry instance can emit.
-</td></tr>
-<tr><td>
-[ChatEventType](./server.hytopia.chateventtype.md)
-</td><td>
-Event types a ChatManager instance can emit.
-</td></tr>
-<tr><td>
-[ChunkEventType](./server.hytopia.chunkeventtype.md)
-</td><td>
-Event types a Chunk instance can emit.
-</td></tr>
-<tr><td>
-[CoefficientCombineRule](./server.hytopia.coefficientcombinerule.md)
-</td><td>
-The coefficient for friction or bounciness combine rule.
-</td></tr>
-<tr><td>
-[ColliderShape](./server.hytopia.collidershape.md)
-</td><td>
-The shapes a collider can be.
-</td></tr>
-<tr><td>
-[CollisionGroup](./server.hytopia.collisiongroup.md)
-</td><td>
-The default collision groups.
-</td></tr>
-<tr><td>
-[EntityEventType](./server.hytopia.entityeventtype.md)
-</td><td>
-Event types an Entity instance can emit.
-</td></tr>
-<tr><td>
-[GameServerEventType](./server.hytopia.gameservereventtype.md)
-</td><td>
-Event types a GameServer instance can emit.
-</td></tr>
-<tr><td>
-[PlayerCameraEventType](./server.hytopia.playercameraeventtype.md)
-</td><td>
-Event types a PlayerCamera can emit.
-</td></tr>
-<tr><td>
-[PlayerCameraMode](./server.hytopia.playercameramode.md)
-</td><td>
-</td></tr>
-<tr><td>
-[PlayerEventType](./server.hytopia.playereventtype.md)
-</td><td>
-Event types a Player can emit.
-</td></tr>
-<tr><td>
-[RigidBodyType](./server.hytopia.rigidbodytype.md)
-</td><td>
-The types a RigidBody can be.
-</td></tr>
-<tr><td>
-[WorldLoopEventType](./server.hytopia.worldloopeventtype.md)
-</td><td>
-Event types a WorldLoop instance can emit.
-</td></tr>
-</tbody></table>
-## Functions
-<table><thead><tr><th>
-Function
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[startServer(init)](./server.hytopia.startserver.md)
-</td><td>
-The entry point for running game setup and starting the game server.
-</td></tr>
-</tbody></table>
-## Interfaces
-<table><thead><tr><th>
-Interface
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[AudioOptions](./server.hytopia.audiooptions.md)
-</td><td>
-Options for creating an Audio instance.
-</td></tr>
-<tr><td>
-[BlockTypeOptions](./server.hytopia.blocktypeoptions.md)
-</td><td>
-Options for creating a block type instance.
-</td></tr>
-<tr><td>
-[ColliderOptions](./server.hytopia.collideroptions.md)
-</td><td>
-Options for creating a Collider instance.
-</td></tr>
-<tr><td>
-[DefaultCharacterControllerOptions](./server.hytopia.defaultcharactercontrolleroptions.md)
-</td><td>
-Options for creating a DefaultCharacterController instance.
-</td></tr>
-<tr><td>
-[EntityOptions](./server.hytopia.entityoptions.md)
-</td><td>
-Options for creating an Entity instance.
-</td></tr>
-<tr><td>
-[Event](./server.hytopia.event.md)
-</td><td>
-An EventRouter event.
-</td></tr>
-<tr><td>
-[PlayerEntityOptions](./server.hytopia.playerentityoptions.md)
-</td><td>
-Options for creating a PlayerEntity instance.
-</td></tr>
-<tr><td>
-[QuaternionLike](./server.hytopia.quaternionlike.md)
-</td><td>
-A quaternion.
-</td></tr>
-<tr><td>
-[RgbColor](./server.hytopia.rgbcolor.md)
-</td><td>
-A RGB color.
-</td></tr>
-<tr><td>
-[RigidBodyOptions](./server.hytopia.rigidbodyoptions.md)
-</td><td>
-Options for creating a RigidBody instance.
-</td></tr>
-<tr><td>
-[SpdMatrix3](./server.hytopia.spdmatrix3.md)
-</td><td>
-A 3x3 symmetric positive-definite matrix for spatial dynamics.
-</td></tr>
-<tr><td>
-[Vector3Boolean](./server.hytopia.vector3boolean.md)
-</td><td>
-A 3-dimensional vector of boolean values.
-</td></tr>
-<tr><td>
-[Vector3Like](./server.hytopia.vector3like.md)
-</td><td>
-A 3-dimensional vector.
-</td></tr>
-<tr><td>
-[WorldMap](./server.hytopia.worldmap.md)
-</td><td>
-A map representation for a world.
-</td></tr>
-<tr><td>
-[WorldOptions](./server.hytopia.worldoptions.md)
-</td><td>
-Options for creating a World instance.
-</td></tr>
-</tbody></table>
-## Namespaces
-<table><thead><tr><th>
-Namespace
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[AudioEventPayload](./server.hytopia.audioeventpayload.md)
-</td><td>
-Payloads for events an Audio instance can emit.
-</td></tr>
-<tr><td>
-[BlockTypeRegistryEventPayload](./server.hytopia.blocktyperegistryeventpayload.md)
-</td><td>
-Payloads for events a BlockTypeRegistry instance can emit.
-</td></tr>
-<tr><td>
-[ChatEventPayload](./server.hytopia.chateventpayload.md)
-</td><td>
-Payloads for events a ChatManager instance can emit.
-</td></tr>
-<tr><td>
-[ChunkEventPayload](./server.hytopia.chunkeventpayload.md)
-</td><td>
-Payloads for events a Chunk instance can emit.
-</td></tr>
-<tr><td>
-[EntityEventPayload](./server.hytopia.entityeventpayload.md)
-</td><td>
-Payloads for events an Entity instance can emit.
-</td></tr>
-<tr><td>
-[GameServerEventPayload](./server.hytopia.gameservereventpayload.md)
-</td><td>
-Payloads for events emitted by a GameServer instance.
-</td></tr>
-<tr><td>
-[PlayerCameraEventPayload](./server.hytopia.playercameraeventpayload.md)
-</td><td>
-Payloads for events a PlayerCamera can emit.
-</td></tr>
-<tr><td>
-[PlayerEventPayload](./server.hytopia.playereventpayload.md)
-</td><td>
-Payloads for events a Player can emit.
-</td></tr>
-<tr><td>
-[WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md)
-</td><td>
-Payloads for events emitted by a WorldLoop instance.
-</td></tr>
-</tbody></table>
-## Variables
-<table><thead><tr><th>
-Variable
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[DEFAULT\_BLOCK\_ENTITY\_RIGID\_BODY\_OPTIONS](./server.hytopia.default_block_entity_rigid_body_options.md)
-</td><td>
-The default rigid body options for a block entity when EntityOptions.rigidBodyOptions is not provided.
-</td></tr>
-<tr><td>
-[DEFAULT\_ENTITY\_RIGID\_BODY\_OPTIONS](./server.hytopia.default_entity_rigid_body_options.md)
-</td><td>
-The default rigid body options for a model entity when EntityOptions.rigidBodyOptions is not provided.
-</td></tr>
-<tr><td>
-[PORT](./server.hytopia.port.md)
-</td><td>
-The port the server will run on. You can override this in your .env by setting PORT. When deployed in production to HYTOPIA servers, any .env value will be ignored and 8080 will be used.
-</td></tr>
-<tr><td>
-[SUPPORTED\_INPUT\_KEYS](./server.hytopia.supported_input_keys.md)
-</td><td>
-The input keys that can be included in the PlayerInputState.
-</td></tr>
-</tbody></table>
-## Type Aliases
-<table><thead><tr><th>
-Type Alias
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[CollisionCallback](./server.hytopia.collisioncallback.md)
-</td><td>
-A callback function that is called when a collision occurs.
-</td></tr>
-<tr><td>
-[CollisionGroups](./server.hytopia.collisiongroups.md)
-</td><td>
-A set of collision groups.
-</td></tr>
-<tr><td>
-[CommandCallback](./server.hytopia.commandcallback.md)
-</td><td>
-A callback function for a chat command.
-</td></tr>
-<tr><td>
-[DecodedCollisionGroups](./server.hytopia.decodedcollisiongroups.md)
-</td><td>
-A decoded set of collision groups represented as their string equivalents.
-</td></tr>
-<tr><td>
-[FaceCallback](./server.hytopia.facecallback.md)
-</td><td>
-A callback function called when the entity associated with the SimpleCharacterController updates its rotation as it is attempting to face a target coordinate.
-</td></tr>
-<tr><td>
-[FaceCompleteCallback](./server.hytopia.facecompletecallback.md)
-</td><td>
-A callback function called when the entity associated with the SimpleCharacterController finishes rotating and is now facing a target coordinate.
-</td></tr>
-<tr><td>
-[FaceOptions](./server.hytopia.faceoptions.md)
-</td><td>
-Options for the [SimpleCharacterController.face()](./server.simplecharactercontroller.face.md) method.
-</td></tr>
-<tr><td>
-[MoveCallback](./server.hytopia.movecallback.md)
-</td><td>
-A callback function called when the entity associated with the SimpleCharacterController updates its translation as it is attempting to move to a target coordinate.
-</td></tr>
-<tr><td>
-[MoveCompleteCallback](./server.hytopia.movecompletecallback.md)
-</td><td>
-A callback function called when the entity associated with the SimpleCharacterController reaches the target coordinate. An entity must reach the x,y,z coordinate for the callback to be called.
-</td></tr>
-<tr><td>
-[MoveOptions](./server.hytopia.moveoptions.md)
-</td><td>
-Options for the [SimpleCharacterController.move()](./server.simplecharactercontroller.move.md) method.
-</td></tr>
-<tr><td>
-[PlayerInputState](./server.hytopia.playerinputstate.md)
-</td><td>
-The input state of a Player; keys from SUPPORTED\_INPUT\_KEYS.
-</td></tr>
-<tr><td>
-[PlayerOrientationState](./server.hytopia.playerorientationstate.md)
-</td><td>
-The camera orientation state of a Player.
-</td></tr>
-<tr><td>
-[RawCollisionGroups](./server.hytopia.rawcollisiongroups.md)
-</td><td>
-A raw set of collision groups represented as a 32-bit number.
-</td></tr>
-<tr><td>
-[RigidBodyAdditionalMassProperties](./server.hytopia.rigidbodyadditionalmassproperties.md)
-</td><td>
-Additional mass properties for a RigidBody.
-</td></tr>
-</tbody></table>