hytopia 0.14.50 → 0.14.52

package/docs/server.baseentityoptions.md

@@ -148,6 +148,25 @@ number
 _(Optional)_ The opacity of the entity between 0 and 1. 0 is fully transparent, 1 is fully opaque.
 
 
+</td></tr>
+<tr><td>
+
+[outline?](./server.baseentityoptions.outline.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Outline](./server.outline.md)
+
+
+</td><td>
+
+_(Optional)_ The outline rendering options for the entity.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.baseentityoptions.outline.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; [BaseEntityOptions](./server.baseentityoptions.md) &gt; [outline](./server.baseentityoptions.outline.md)
+
+## BaseEntityOptions.outline property
+
+The outline rendering options for the entity.
+
+**Signature:**
+
+```typescript
+outline?: Outline;
+```

package/docs/server.entity.md

@@ -594,6 +594,27 @@ number
 The opacity of the entity between 0 and 1. 0 is fully transparent, 1 is fully opaque.
 
 
+</td></tr>
+<tr><td>
+
+[outline](./server.entity.outline.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Outline](./server.outline.md) \| undefined
+
+
+</td><td>
+
+The outline rendering options for the entity.
+
+
 </td></tr>
 <tr><td>
 
@@ -922,6 +943,20 @@ Sets the texture uri of the entity's model. Setting this overrides the model's d
 Sets the opacity of the entity.
 
 
+</td></tr>
+<tr><td>
+
+[setOutline(outline, forPlayer)](./server.entity.setoutline.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the outline rendering options for the entity.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entity.outline.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; [outline](./server.entity.outline.md)
+
+## Entity.outline property
+
+The outline rendering options for the entity.
+
+**Signature:**
+
+```typescript
+get outline(): Outline | undefined;
+```

package/docs/server.entity.setoutline.md

@@ -0,0 +1,69 @@
+<!-- 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; [setOutline](./server.entity.setoutline.md)
+
+## Entity.setOutline() method
+
+Sets the outline rendering options for the entity.
+
+**Signature:**
+
+```typescript
+setOutline(outline: Outline | undefined, forPlayer?: Player): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+outline
+
+
+</td><td>
+
+[Outline](./server.outline.md) \| undefined
+
+
+</td><td>
+
+The outline options, or undefined to remove the outline.
+
+
+</td></tr>
+<tr><td>
+
+forPlayer
+
+
+</td><td>
+
+[Player](./server.player.md)
+
+
+</td><td>
+
+_(Optional)_ The player to set the outline for, if undefined the outline will be set for all players.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.entityevent.md

@@ -239,6 +239,20 @@ SET\_OPACITY
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+SET\_OUTLINE
+
+
+</td><td>
+
+`"ENTITY.SET_OUTLINE"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entityeventpayloads._entity.set_outline_.md

@@ -0,0 +1,17 @@
+<!-- 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\_OUTLINE"](./server.entityeventpayloads._entity.set_outline_.md)
+
+## EntityEventPayloads."ENTITY.SET\_OUTLINE" property
+
+Emitted when the outline of the entity is set.
+
+**Signature:**
+
+```typescript
+[EntityEvent.SET_OUTLINE]: {
+        entity: Entity;
+        outline: Outline | undefined;
+        forPlayer?: Player;
+    };
+```

package/docs/server.entityeventpayloads.md

@@ -319,6 +319,25 @@ Emitted when the texture uri of the entity's model is set.
 Emitted when the opacity of the entity is set.
 
 
+</td></tr>
+<tr><td>
+
+["ENTITY.SET\_OUTLINE"](./server.entityeventpayloads._entity.set_outline_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; outline: [Outline](./server.outline.md) \| undefined; forPlayer?: [Player](./server.player.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the outline of the entity is set.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.md

@@ -1165,6 +1165,17 @@ The options for creating a model entity.
 The options for an error type "none" collider.
 
 
+</td></tr>
+<tr><td>
+
+[Outline](./server.outline.md)
+
+
+</td><td>
+
+The options for rendering an outline.
+
+
 </td></tr>
 <tr><td>
 
@@ -1743,6 +1754,17 @@ A callback function called when the entity associated with the SimpleEntityContr
 Options for the [SimpleEntityController.move()](./server.simpleentitycontroller.move.md) method.
 
 
+</td></tr>
+<tr><td>
+
+[ParticleEmitterOrientation](./server.particleemitterorientation.md)
+
+
+</td><td>
+
+The orientation mode for particles.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.outline.color.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; [Outline](./server.outline.md) &gt; [color](./server.outline.color.md)
+
+## Outline.color property
+
+The color of the outline. Defaults to black.
+
+**Signature:**
+
+```typescript
+color?: RgbColor;
+```

package/docs/server.outline.colorintensity.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; [Outline](./server.outline.md) &gt; [colorIntensity](./server.outline.colorintensity.md)
+
+## Outline.colorIntensity property
+
+The intensity multiplier for the outline color. Use values over 1 for brighter/glowing outlines. Defaults to 1.0.
+
+**Signature:**
+
+```typescript
+colorIntensity?: number;
+```

package/docs/server.outline.md

@@ -0,0 +1,133 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Outline](./server.outline.md)
+
+## Outline interface
+
+The options for rendering an outline.
+
+**Signature:**
+
+```typescript
+interface Outline 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[color?](./server.outline.color.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[RgbColor](./server.rgbcolor.md)
+
+
+</td><td>
+
+_(Optional)_ The color of the outline. Defaults to black.
+
+
+</td></tr>
+<tr><td>
+
+[colorIntensity?](./server.outline.colorintensity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The intensity multiplier for the outline color. Use values over 1 for brighter/glowing outlines. Defaults to 1.0.
+
+
+</td></tr>
+<tr><td>
+
+[occluded?](./server.outline.occluded.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether the outline should be visible when the entity is occluded by other objects. Defaults to true.
+
+
+</td></tr>
+<tr><td>
+
+[opacity?](./server.outline.opacity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The opacity of the outline between 0 and 1. Defaults to 1.0.
+
+
+</td></tr>
+<tr><td>
+
+[thickness?](./server.outline.thickness.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The thickness of the outline in world units. Defaults to 0.05.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.outline.occluded.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; [Outline](./server.outline.md) &gt; [occluded](./server.outline.occluded.md)
+
+## Outline.occluded property
+
+Whether the outline should be visible when the entity is occluded by other objects. Defaults to true.
+
+**Signature:**
+
+```typescript
+occluded?: boolean;
+```

package/docs/server.outline.opacity.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; [Outline](./server.outline.md) &gt; [opacity](./server.outline.opacity.md)
+
+## Outline.opacity property
+
+The opacity of the outline between 0 and 1. Defaults to 1.0.
+
+**Signature:**
+
+```typescript
+opacity?: number;
+```

package/docs/server.outline.thickness.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; [Outline](./server.outline.md) &gt; [thickness](./server.outline.thickness.md)
+
+## Outline.thickness property
+
+The thickness of the outline in world units. Defaults to 0.05.
+
+**Signature:**
+
+```typescript
+thickness?: number;
+```

package/docs/server.particleemitter.locktoemitter.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; [ParticleEmitter](./server.particleemitter.md) &gt; [lockToEmitter](./server.particleemitter.locktoemitter.md)
+
+## ParticleEmitter.lockToEmitter property
+
+Whether emitted particles follow the emitter's world position. Cannot be changed after construction.
+
+**Signature:**
+
+```typescript
+get lockToEmitter(): boolean;
+```

package/docs/server.particleemitter.md

@@ -426,6 +426,27 @@ number \| undefined
 The lifetime variance of an emitted particle in seconds.
 
 
+</td></tr>
+<tr><td>
+
+[lockToEmitter](./server.particleemitter.locktoemitter.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether emitted particles follow the emitter's world position. Cannot be changed after construction.
+
+
 </td></tr>
 <tr><td>
 
@@ -552,6 +573,48 @@ number \| undefined
 The opacity variance of an emitted particle at the start of its lifetime.
 
 
+</td></tr>
+<tr><td>
+
+[orientation](./server.particleemitter.orientation.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[ParticleEmitterOrientation](./server.particleemitterorientation.md) \| undefined
+
+
+</td><td>
+
+The orientation mode of emitted particles.
+
+
+</td></tr>
+<tr><td>
+
+[orientationFixedRotation](./server.particleemitter.orientationfixedrotation.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md) \| undefined
+
+
+</td><td>
+
+The fixed rotation of emitted particles in degrees when orientation is 'fixed'.
+
+
 </td></tr>
 <tr><td>
 
@@ -1209,6 +1272,34 @@ Sets the opacity of an emitted particle at the start of its lifetime.
 Sets the opacity variance of an emitted particle at the start of its lifetime.
 
 
+</td></tr>
+<tr><td>
+
+[setOrientation(orientation)](./server.particleemitter.setorientation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the orientation mode of emitted particles.
+
+
+</td></tr>
+<tr><td>
+
+[setOrientationFixedRotation(orientationFixedRotation)](./server.particleemitter.setorientationfixedrotation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the fixed rotation of emitted particles when orientation is 'fixed'.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.particleemitter.orientation.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; [ParticleEmitter](./server.particleemitter.md) &gt; [orientation](./server.particleemitter.orientation.md)
+
+## ParticleEmitter.orientation property
+
+The orientation mode of emitted particles.
+
+**Signature:**
+
+```typescript
+get orientation(): ParticleEmitterOrientation | undefined;
+```

package/docs/server.particleemitter.orientationfixedrotation.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; [ParticleEmitter](./server.particleemitter.md) &gt; [orientationFixedRotation](./server.particleemitter.orientationfixedrotation.md)
+
+## ParticleEmitter.orientationFixedRotation property
+
+The fixed rotation of emitted particles in degrees when orientation is 'fixed'.
+
+**Signature:**
+
+```typescript
+get orientationFixedRotation(): Vector3Like | undefined;
+```

package/docs/server.particleemitter.setorientation.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; [ParticleEmitter](./server.particleemitter.md) &gt; [setOrientation](./server.particleemitter.setorientation.md)
+
+## ParticleEmitter.setOrientation() method
+
+Sets the orientation mode of emitted particles.
+
+**Signature:**
+
+```typescript
+setOrientation(orientation: ParticleEmitterOrientation): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+orientation
+
+
+</td><td>
+
+[ParticleEmitterOrientation](./server.particleemitterorientation.md)
+
+
+</td><td>
+
+The orientation mode. 'billboard' faces the camera, 'billboardY' faces the camera but keeps Y-axis upward, 'fixed' uses a fixed rotation.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+