hytopia 0.6.27 → 0.6.29

package/docs/server.collider.md

@@ -517,6 +517,18 @@ Creates a collider options object from a modelUri with best approximate shape an
 Removes the collider from the simulation.
 
 
+</td></tr>
+<tr><td>
+
+[scale(scalar)](./server.collider.scale.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.collider.scale.md

@@ -0,0 +1,49 @@
+<!-- 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; [scale](./server.collider.scale.md)
+
+## Collider.scale() method
+
+**Signature:**
+
+```typescript
+scale(scalar: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+scalar
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.entity.md

@@ -727,6 +727,20 @@ Sets the playback rate of all animations on the entity's model.
 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>
+
+[setModelScale(modelScale)](./server.entity.setmodelscale.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the scale of the entity's model and proportionally scales its colliders.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entity.setmodelscale.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; [setModelScale](./server.entity.setmodelscale.md)
+
+## Entity.setModelScale() method
+
+Sets the scale of the entity's model and proportionally scales its colliders.
+
+**Signature:**
+
+```typescript
+setModelScale(modelScale: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+modelScale
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The scale of the entity's model.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.entityevent.md

@@ -127,6 +127,20 @@ SET\_MODEL\_HIDDEN\_NODES
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+SET\_MODEL\_SCALE
+
+
+</td><td>
+
+`"ENTITY.SET_MODEL_SCALE"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entityeventpayloads._entity.set_model_scale_.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; [EntityEventPayloads](./server.entityeventpayloads.md) &gt; ["ENTITY.SET\_MODEL\_SCALE"](./server.entityeventpayloads._entity.set_model_scale_.md)
+
+## EntityEventPayloads."ENTITY.SET\_MODEL\_SCALE" property
+
+Emitted when the scale of the entity's model is set.
+
+**Signature:**
+
+```typescript
+[EntityEvent.SET_MODEL_SCALE]: {
+        entity: Entity;
+        modelScale: number;
+    };
+```

package/docs/server.entityeventpayloads.md

@@ -167,6 +167,25 @@ Emitted when the playback rate of the entity's model animations is set.
 Emitted when nodes of the entity's model are set to be hidden.
 
 
+</td></tr>
+<tr><td>
+
+["ENTITY.SET\_MODEL\_SCALE"](./server.entityeventpayloads._entity.set_model_scale_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; modelScale: number; }
+
+
+</td><td>
+
+Emitted when the scale of the entity's model is set.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.world.fogcolor.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; [World](./server.world.md) &gt; [fogColor](./server.world.fogcolor.md)
+
+## World.fogColor property
+
+The color of the fog, if not explicitly set, defaults to ambient light color.
+
+**Signature:**
+
+```typescript
+get fogColor(): RgbColor | undefined;
+```

package/docs/server.world.fogfar.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; [World](./server.world.md) &gt; [fogFar](./server.world.fogfar.md)
+
+## World.fogFar property
+
+The maximum distance from the camera at which fog stops being applied.
+
+**Signature:**
+
+```typescript
+get fogFar(): number;
+```

package/docs/server.world.fognear.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; [World](./server.world.md) &gt; [fogNear](./server.world.fognear.md)
+
+## World.fogNear property
+
+The minimum distance from the camera to start applying fog.
+
+**Signature:**
+
+```typescript
+get fogNear(): number;
+```

package/docs/server.world.md

@@ -300,6 +300,69 @@ The position the directional light originates from.
 The entity manager for the world.
 
 
+</td></tr>
+<tr><td>
+
+[fogColor](./server.world.fogcolor.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[RgbColor](./server.rgbcolor.md) \| undefined
+
+
+</td><td>
+
+The color of the fog, if not explicitly set, defaults to ambient light color.
+
+
+</td></tr>
+<tr><td>
+
+[fogFar](./server.world.fogfar.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The maximum distance from the camera at which fog stops being applied.
+
+
+</td></tr>
+<tr><td>
+
+[fogNear](./server.world.fognear.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The minimum distance from the camera to start applying fog.
+
+
 </td></tr>
 <tr><td>
 
@@ -593,6 +656,48 @@ Sets the intensity of the world's directional light.
 Sets the position the world's directional light originates from.
 
 
+</td></tr>
+<tr><td>
+
+[setFogColor(color)](./server.world.setfogcolor.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the color of the world's fog.
+
+
+</td></tr>
+<tr><td>
+
+[setFogFar(far)](./server.world.setfogfar.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the maximum distance from the camera at which fog stops being applied.
+
+
+</td></tr>
+<tr><td>
+
+[setFogNear(near)](./server.world.setfognear.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the minimum distance from the camera to start applying fog.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.world.setfogcolor.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; [World](./server.world.md) &gt; [setFogColor](./server.world.setfogcolor.md)
+
+## World.setFogColor() method
+
+Sets the color of the world's fog.
+
+**Signature:**
+
+```typescript
+setFogColor(color: RgbColor | undefined): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+color
+
+
+</td><td>
+
+[RgbColor](./server.rgbcolor.md) \| undefined
+
+
+</td><td>
+
+The color of the fog, or undefined to reset to ambient light color.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.world.setfogfar.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; [World](./server.world.md) &gt; [setFogFar](./server.world.setfogfar.md)
+
+## World.setFogFar() method
+
+Sets the maximum distance from the camera at which fog stops being applied.
+
+**Signature:**
+
+```typescript
+setFogFar(far: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+far
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The far distance.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.world.setfognear.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; [World](./server.world.md) &gt; [setFogNear](./server.world.setfognear.md)
+
+## World.setFogNear() method
+
+Sets the minimum distance from the camera to start applying fog.
+
+**Signature:**
+
+```typescript
+setFogNear(near: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+near
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The near distance.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.worldevent.md

@@ -99,6 +99,48 @@ SET\_DIRECTIONAL\_LIGHT\_POSITION
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+SET\_FOG\_COLOR
+
+
+</td><td>
+
+`"WORLD.SET_FOG_COLOR"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_FOG\_FAR
+
+
+</td><td>
+
+`"WORLD.SET_FOG_FAR"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_FOG\_NEAR
+
+
+</td><td>
+
+`"WORLD.SET_FOG_NEAR"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.worldeventpayloads._world.set_fog_color_.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; [WorldEventPayloads](./server.worldeventpayloads.md) &gt; ["WORLD.SET\_FOG\_COLOR"](./server.worldeventpayloads._world.set_fog_color_.md)
+
+## WorldEventPayloads."WORLD.SET\_FOG\_COLOR" property
+
+Emitted when the color of the world's fog is set.
+
+**Signature:**
+
+```typescript
+[WorldEvent.SET_FOG_COLOR]: {
+        world: World;
+        color: RgbColor;
+    };
+```

package/docs/server.worldeventpayloads._world.set_fog_far_.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; [WorldEventPayloads](./server.worldeventpayloads.md) &gt; ["WORLD.SET\_FOG\_FAR"](./server.worldeventpayloads._world.set_fog_far_.md)
+
+## WorldEventPayloads."WORLD.SET\_FOG\_FAR" property
+
+Emitted when the density of the world's fog is set.
+
+**Signature:**
+
+```typescript
+[WorldEvent.SET_FOG_FAR]: {
+        world: World;
+        far: number;
+    };
+```

package/docs/server.worldeventpayloads._world.set_fog_near_.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; [WorldEventPayloads](./server.worldeventpayloads.md) &gt; ["WORLD.SET\_FOG\_NEAR"](./server.worldeventpayloads._world.set_fog_near_.md)
+
+## WorldEventPayloads."WORLD.SET\_FOG\_NEAR" property
+
+Emitted when the density of the world's fog is set.
+
+**Signature:**
+
+```typescript
+[WorldEvent.SET_FOG_NEAR]: {
+        world: World;
+        near: number;
+    };
+```

package/docs/server.worldeventpayloads.md

@@ -129,6 +129,63 @@ Emitted when the intensity of the world's directional light is set.
 Emitted when the position of the world's directional light is set.
 
 
+</td></tr>
+<tr><td>
+
+["WORLD.SET\_FOG\_COLOR"](./server.worldeventpayloads._world.set_fog_color_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ world: [World](./server.world.md)<!-- -->; color: [RgbColor](./server.rgbcolor.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the color of the world's fog is set.
+
+
+</td></tr>
+<tr><td>
+
+["WORLD.SET\_FOG\_FAR"](./server.worldeventpayloads._world.set_fog_far_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ world: [World](./server.world.md)<!-- -->; far: number; }
+
+
+</td><td>
+
+Emitted when the density of the world's fog is set.
+
+
+</td></tr>
+<tr><td>
+
+["WORLD.SET\_FOG\_NEAR"](./server.worldeventpayloads._world.set_fog_near_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ world: [World](./server.world.md)<!-- -->; near: number; }
+
+
+</td><td>
+
+Emitted when the density of the world's fog is set.
+
+
 </td></tr>
 <tr><td>