hytopia 0.8.6-dev4 → 0.8.6-dev6

package/docs/server.particleemitterevent.md

@@ -32,20 +32,6 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-BURST
-
-
-</td><td>
-
-`"PARTICLE_EMITTER.BURST"`
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
 DESPAWN
 
 

package/docs/server.particleemittereventpayloads.md

@@ -37,25 +37,6 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-["PARTICLE\_EMITTER.BURST"](./server.particleemittereventpayloads._particle_emitter.burst_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; count: number; }
-
-
-</td><td>
-
-Emitted when a ParticleEmitter bursts the specified number of particles.
-
-
-</td></tr>
-<tr><td>
-
 ["PARTICLE\_EMITTER.DESPAWN"](./server.particleemittereventpayloads._particle_emitter.despawn_.md)
 
 

package/docs/server.particleemittermanager.getallparticleemitters.md

@@ -9,8 +9,45 @@ Retrieves all spawned ParticleEmitter instances for the world.
 **Signature:**
 
 ```typescript
-getAllParticleEmitters(): ParticleEmitter[];
+getAllParticleEmitters(tickAllocated?: boolean): ParticleEmitter[];
 ```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+tickAllocated
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether to use the tick allocator to allocate the returned array of ParticleEmitter instances. The allocated array will be collected and released at the end of the current tick if true. Only use this if you know what you're doing.
+
+
+</td></tr>
+</tbody></table>
+
 **Returns:**
 
 [ParticleEmitter](./server.particleemitter.md)<!-- -->\[\]

package/docs/server.particleemittermanager.md

@@ -98,7 +98,7 @@ Retrieves all spawned ParticleEmitter instances attached to a specific entity.
 </td></tr>
 <tr><td>
 
-[getAllParticleEmitters()](./server.particleemittermanager.getallparticleemitters.md)
+[getAllParticleEmitters(tickAllocated)](./server.particleemittermanager.getallparticleemitters.md)
 
 
 </td><td>

package/docs/server.rgbcolor.md

@@ -4,7 +4,7 @@
 
 ## RgbColor interface
 
-A RGB color. r, g and b expect a value between 0 and 255.
+A RGB color.
 
 **Signature:**
 

package/docs/server.sceneuimanager.getallsceneuis.md

@@ -9,8 +9,45 @@ Retrieves all loaded SceneUI instances for the world.
 **Signature:**
 
 ```typescript
-getAllSceneUIs(): SceneUI[];
+getAllSceneUIs(tickAllocated?: boolean): SceneUI[];
 ```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+tickAllocated
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether to use the tick allocator to allocate the returned array of SceneUI instances. The allocated array will be collected and released at the end of the current tick if true. Only use this if you know what you're doing.
+
+
+</td></tr>
+</tbody></table>
+
 **Returns:**
 
 [SceneUI](./server.sceneui.md)<!-- -->\[\]

package/docs/server.sceneuimanager.md

@@ -98,7 +98,7 @@ Retrieves all loaded SceneUI instances attached to a specific entity.
 </td></tr>
 <tr><td>
 
-[getAllSceneUIs()](./server.sceneuimanager.getallsceneuis.md)
+[getAllSceneUIs(tickAllocated)](./server.sceneuimanager.getallsceneuis.md)
 
 
 </td><td>

package/docs/server.tickallocator.getarray.md

@@ -0,0 +1,72 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [TickAllocator](./server.tickallocator.md) &gt; [getArray](./server.tickallocator.getarray.md)
+
+## TickAllocator.getArray() method
+
+Gets a generic array from the pool. Array is reset to empty state and ready for use.
+
+**Signature:**
+
+```typescript
+getArray<T extends unknown[] = unknown[]>(copyFromA?: Iterable<unknown>, copyFromB?: Iterable<unknown>): T;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+copyFromA
+
+
+</td><td>
+
+Iterable&lt;unknown&gt;
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+copyFromB
+
+
+</td><td>
+
+Iterable&lt;unknown&gt;
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+T
+
+A reusable array.
+

package/docs/server.tickallocator.getarray3number.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [TickAllocator](./server.tickallocator.md) &gt; [getArray3Number](./server.tickallocator.getarray3number.md)
+
+## TickAllocator.getArray3Number() method
+
+Gets a 3-element number array from the pool. Array is reset to \[0, 0, 0\] and ready for use.
+
+**Signature:**
+
+```typescript
+getArray3Number(copyFrom?: Array3Number | Set<number>): Array3Number;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+copyFrom
+
+
+</td><td>
+
+[Array3Number](./server.array3number.md) \| Set&lt;number&gt;
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[Array3Number](./server.array3number.md)
+
+A reusable 3-element array.
+

package/docs/server.tickallocator.getarray4number.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [TickAllocator](./server.tickallocator.md) &gt; [getArray4Number](./server.tickallocator.getarray4number.md)
+
+## TickAllocator.getArray4Number() method
+
+Gets a 4-element number array from the pool. Array is reset to \[0, 0, 0, 0\] and ready for use.
+
+**Signature:**
+
+```typescript
+getArray4Number(copyFrom?: Array4Number | Set<number>): Array4Number;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+copyFrom
+
+
+</td><td>
+
+[Array4Number](./server.array4number.md) \| Set&lt;number&gt;
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[Array4Number](./server.array4number.md)
+
+A reusable 4-element array.
+

package/docs/server.tickallocator.getobject.md

@@ -0,0 +1,72 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [TickAllocator](./server.tickallocator.md) &gt; [getObject](./server.tickallocator.getobject.md)
+
+## TickAllocator.getObject() method
+
+Gets a plain object from the pool. Object is reset to empty state and ready for use.
+
+**Signature:**
+
+```typescript
+getObject<T extends Record<string, unknown> = Record<string, unknown>>(copyFromA?: T, copyFromB?: T): T;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+copyFromA
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+copyFromB
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+T
+
+A reusable plain object.
+

package/docs/server.tickallocator.getset.md

@@ -0,0 +1,72 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [TickAllocator](./server.tickallocator.md) &gt; [getSet](./server.tickallocator.getset.md)
+
+## TickAllocator.getSet() method
+
+Gets a set from the pool. Set is reset to empty state and ready for use.
+
+**Signature:**
+
+```typescript
+getSet<T>(copyFromA?: Set<T> | T[], copyFromB?: Set<T> | T[]): Set<T>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+copyFromA
+
+
+</td><td>
+
+Set&lt;T&gt; \| T\[\]
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+copyFromB
+
+
+</td><td>
+
+Set&lt;T&gt; \| T\[\]
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Set&lt;T&gt;
+
+A reusable set.
+

package/docs/server.tickallocator.map.md

@@ -0,0 +1,72 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [TickAllocator](./server.tickallocator.md) &gt; [map](./server.tickallocator.map.md)
+
+## TickAllocator.map() method
+
+Maps an array to a new array using a callback function.
+
+**Signature:**
+
+```typescript
+map<T, U>(array: T[], callback: (value: T, index: number, array: T[]) => U): U[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+array
+
+
+</td><td>
+
+T\[\]
+
+
+</td><td>
+
+The array to map.
+
+
+</td></tr>
+<tr><td>
+
+callback
+
+
+</td><td>
+
+(value: T, index: number, array: T\[\]) =&gt; U
+
+
+</td><td>
+
+The callback function to map the array.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+U\[\]
+
+A new array with the mapped values.
+