hytopia 0.1.69 → 0.1.71

package/docs/server.lightmanager.getallentityattachedlights.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; [LightManager](./server.lightmanager.md) &gt; [getAllEntityAttachedLights](./server.lightmanager.getallentityattachedlights.md)
+
+## LightManager.getAllEntityAttachedLights() method
+
+Retrieves all spawned Light instances attached to a specific entity.
+
+**Signature:**
+
+```typescript
+getAllEntityAttachedLights(entity: Entity): Light[];
+```
+
+## 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 to get attached Light instances for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Light](./server.light.md)<!-- -->\[\]
+
+An array of Light instances.
+

package/docs/server.lightmanager.getalllights.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; [LightManager](./server.lightmanager.md) &gt; [getAllLights](./server.lightmanager.getalllights.md)
+
+## LightManager.getAllLights() method
+
+Retrieves all spawned Light instances for the world.
+
+**Signature:**
+
+```typescript
+getAllLights(): Light[];
+```
+**Returns:**
+
+[Light](./server.light.md)<!-- -->\[\]
+
+An array of Light instances.
+

package/docs/server.lightmanager.md

@@ -0,0 +1,113 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [LightManager](./server.lightmanager.md)
+
+## LightManager class
+
+Manages Light instances in a world.
+
+**Signature:**
+
+```typescript
+export default class LightManager 
+```
+
+## Remarks
+
+The LightManager is created internally as a singleton for each [World](./server.world.md) instance in a game server. It allows retrieval of all loaded Light instances, entity attached Light instances, and more.
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `LightManager` class.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[world](./server.lightmanager.world.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[World](./server.world.md)
+
+
+</td><td>
+
+The world the LightManager is for.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getAllEntityAttachedLights(entity)](./server.lightmanager.getallentityattachedlights.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves all spawned Light instances attached to a specific entity.
+
+
+</td></tr>
+<tr><td>
+
+[getAllLights()](./server.lightmanager.getalllights.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves all spawned Light instances for the world.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.lightmanager.world.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; [LightManager](./server.lightmanager.md) &gt; [world](./server.lightmanager.world.md)
+
+## LightManager.world property
+
+The world the LightManager is for.
+
+**Signature:**
+
+```typescript
+get world(): World;
+```

package/docs/server.lightoptions.angle.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; [LightOptions](./server.lightoptions.md) &gt; [angle](./server.lightoptions.angle.md)
+
+## LightOptions.angle property
+
+If type is spotlight, the angle of the spotlight.
+
+**Signature:**
+
+```typescript
+angle?: number;
+```

package/docs/server.lightoptions.attachedtoentity.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; [LightOptions](./server.lightoptions.md) &gt; [attachedToEntity](./server.lightoptions.attachedtoentity.md)
+
+## LightOptions.attachedToEntity property
+
+If set, the light will be attached to this entity.
+
+**Signature:**
+
+```typescript
+attachedToEntity?: Entity;
+```

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

package/docs/server.lightoptions.distance.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; [LightOptions](./server.lightoptions.md) &gt; [distance](./server.lightoptions.distance.md)
+
+## LightOptions.distance property
+
+The maximum distance the light will illuminate. 0 does not limit distance. Defaults to 0.
+
+**Signature:**
+
+```typescript
+distance?: number;
+```

package/docs/server.lightoptions.intensity.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; [LightOptions](./server.lightoptions.md) &gt; [intensity](./server.lightoptions.intensity.md)
+
+## LightOptions.intensity property
+
+The intensity of the light in candela (cd). Defaults to 1
+
+**Signature:**
+
+```typescript
+intensity?: number;
+```

package/docs/server.lightoptions.md

@@ -0,0 +1,247 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [LightOptions](./server.lightoptions.md)
+
+## LightOptions interface
+
+Options for creating a Light instance.
+
+**Signature:**
+
+```typescript
+export interface LightOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[angle?](./server.lightoptions.angle.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ If type is spotlight, the angle of the spotlight.
+
+
+</td></tr>
+<tr><td>
+
+[attachedToEntity?](./server.lightoptions.attachedtoentity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+_(Optional)_ If set, the light will be attached to this entity.
+
+
+</td></tr>
+<tr><td>
+
+[color?](./server.lightoptions.color.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[RgbColor](./server.rgbcolor.md)
+
+
+</td><td>
+
+_(Optional)_ The color of the light. Defaults to white.
+
+
+</td></tr>
+<tr><td>
+
+[distance?](./server.lightoptions.distance.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The maximum distance the light will illuminate. 0 does not limit distance. Defaults to 0.
+
+
+</td></tr>
+<tr><td>
+
+[intensity?](./server.lightoptions.intensity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The intensity of the light in candela (cd). Defaults to 1
+
+
+</td></tr>
+<tr><td>
+
+[offset?](./server.lightoptions.offset.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+_(Optional)_ The offset of the light from the attached entity or position.
+
+
+</td></tr>
+<tr><td>
+
+[penumbra?](./server.lightoptions.penumbra.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ If type is spotlight, the penumbra of the spotlight. Defaults to 0
+
+
+</td></tr>
+<tr><td>
+
+[position?](./server.lightoptions.position.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+_(Optional)_ If set, the light will be attached at this position.
+
+
+</td></tr>
+<tr><td>
+
+[trackedEntity?](./server.lightoptions.trackedentity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+_(Optional)_ If type is spotlight, the entity the spotlight will constantly point at.
+
+
+</td></tr>
+<tr><td>
+
+[trackedPosition?](./server.lightoptions.trackedposition.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+_(Optional)_ If type is spotlight, the position the spotlight will constantly point at.
+
+
+</td></tr>
+<tr><td>
+
+[type?](./server.lightoptions.type.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[LightType](./server.lighttype.md)
+
+
+</td><td>
+
+_(Optional)_ The type of light. Defaults to point light.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.lightoptions.offset.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; [LightOptions](./server.lightoptions.md) &gt; [offset](./server.lightoptions.offset.md)
+
+## LightOptions.offset property
+
+The offset of the light from the attached entity or position.
+
+**Signature:**
+
+```typescript
+offset?: Vector3Like;
+```

package/docs/server.lightoptions.penumbra.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; [LightOptions](./server.lightoptions.md) &gt; [penumbra](./server.lightoptions.penumbra.md)
+
+## LightOptions.penumbra property
+
+If type is spotlight, the penumbra of the spotlight. Defaults to 0
+
+**Signature:**
+
+```typescript
+penumbra?: number;
+```

package/docs/server.lightoptions.position.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; [LightOptions](./server.lightoptions.md) &gt; [position](./server.lightoptions.position.md)
+
+## LightOptions.position property
+
+If set, the light will be attached at this position.
+
+**Signature:**
+
+```typescript
+position?: Vector3Like;
+```

package/docs/server.lightoptions.trackedentity.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; [LightOptions](./server.lightoptions.md) &gt; [trackedEntity](./server.lightoptions.trackedentity.md)
+
+## LightOptions.trackedEntity property
+
+If type is spotlight, the entity the spotlight will constantly point at.
+
+**Signature:**
+
+```typescript
+trackedEntity?: Entity;
+```

package/docs/server.lightoptions.trackedposition.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; [LightOptions](./server.lightoptions.md) &gt; [trackedPosition](./server.lightoptions.trackedposition.md)
+
+## LightOptions.trackedPosition property
+
+If type is spotlight, the position the spotlight will constantly point at.
+
+**Signature:**
+
+```typescript
+trackedPosition?: Vector3Like;
+```

package/docs/server.lightoptions.type.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; [LightOptions](./server.lightoptions.md) &gt; [type](./server.lightoptions.type.md)
+
+## LightOptions.type property
+
+The type of light. Defaults to point light.
+
+**Signature:**
+
+```typescript
+type?: LightType;
+```

package/docs/server.lighttype.md

@@ -0,0 +1,61 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [LightType](./server.lighttype.md)
+
+## LightType enum
+
+The types a Light can be.
+
+**Signature:**
+
+```typescript
+export declare enum LightType 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+POINTLIGHT
+
+
+</td><td>
+
+`0`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SPOTLIGHT
+
+
+</td><td>
+
+`1`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>