hytopia 0.7.1 → 0.7.3-dev1

package/docs/server.particleemittereventpayloads.md

@@ -357,6 +357,25 @@ Emitted when the opacity variance of an emitted particle at the start of its lif
 Emitted when the opacity of an emitted particle at the start of its lifetime is set.
 
 
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_PAUSED"](./server.particleemittereventpayloads._particle_emitter.set_paused_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; paused: boolean; }
+
+
+</td><td>
+
+Emitted when the paused state of an emitted particle is set.
+
+
 </td></tr>
 <tr><td>
 
@@ -436,7 +455,45 @@ Emitted when the rate per second at which particles are emitted is set.
 </td></tr>
 <tr><td>
 
-["PARTICLE\_EMITTER.SET\_SIZE\_VARIANCE"](./server.particleemittereventpayloads._particle_emitter.set_size_variance_.md)
+["PARTICLE\_EMITTER.SET\_SIZE\_END\_VARIANCE"](./server.particleemittereventpayloads._particle_emitter.set_size_end_variance_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; sizeEndVariance: number; }
+
+
+</td><td>
+
+Emitted when the size variance at the end of an emitted particle's lifetime is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_SIZE\_END"](./server.particleemittereventpayloads._particle_emitter.set_size_end_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; sizeEnd: number; }
+
+
+</td><td>
+
+Emitted when the size at the end of an emitted particle's lifetime is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_SIZE\_START\_VARIANCE"](./server.particleemittereventpayloads._particle_emitter.set_size_start_variance_.md)
 
 
 </td><td>
@@ -444,18 +501,18 @@ Emitted when the rate per second at which particles are emitted is set.
 
 </td><td>
 
-{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; sizeVariance: number; }
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; sizeStartVariance: number; }
 
 
 </td><td>
 
-Emitted when the size variance of an emitted particle is set.
+Emitted when the size variance at the start of an emitted particle's lifetime is set.
 
 
 </td></tr>
 <tr><td>
 
-["PARTICLE\_EMITTER.SET\_SIZE"](./server.particleemittereventpayloads._particle_emitter.set_size_.md)
+["PARTICLE\_EMITTER.SET\_SIZE\_START"](./server.particleemittereventpayloads._particle_emitter.set_size_start_.md)
 
 
 </td><td>
@@ -463,12 +520,12 @@ Emitted when the size variance of an emitted particle is set.
 
 </td><td>
 
-{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; size: number; }
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; sizeStart: number; }
 
 
 </td><td>
 
-Emitted when the size of an emitted particle is set.
+Emitted when the size at the start of an emitted particle's lifetime is set.
 
 
 </td></tr>

package/docs/server.particleemittermanager.getallparticleemitters.md

@@ -9,8 +9,44 @@ 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.particleemitteroptions.md

@@ -417,7 +417,7 @@ _(Optional)_ The rate per second variance of the particle emission rate.
 </td></tr>
 <tr><td>
 
-[size?](./server.particleemitteroptions.size.md)
+[sizeEnd?](./server.particleemitteroptions.sizeend.md)
 
 
 </td><td>
@@ -430,13 +430,13 @@ number
 
 </td><td>
 
-_(Optional)_ The size of an emitted particle.
+_(Optional)_ The size at the end of an emitted particle's lifetime.
 
 
 </td></tr>
 <tr><td>
 
-[sizeVariance?](./server.particleemitteroptions.sizevariance.md)
+[sizeEndVariance?](./server.particleemitteroptions.sizeendvariance.md)
 
 
 </td><td>
@@ -449,7 +449,45 @@ number
 
 </td><td>
 
-_(Optional)_ The size variance of an emitted particle.
+_(Optional)_ The size variance at the end of an emitted particle's lifetime.
+
+
+</td></tr>
+<tr><td>
+
+[sizeStart?](./server.particleemitteroptions.sizestart.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The size at the start of an emitted particle's lifetime.
+
+
+</td></tr>
+<tr><td>
+
+[sizeStartVariance?](./server.particleemitteroptions.sizestartvariance.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The size variance at the start of an emitted particle's lifetime.
 
 
 </td></tr>

package/docs/server.particleemitteroptions.sizeend.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; [ParticleEmitterOptions](./server.particleemitteroptions.md) &gt; [sizeEnd](./server.particleemitteroptions.sizeend.md)
+
+## ParticleEmitterOptions.sizeEnd property
+
+The size at the end of an emitted particle's lifetime.
+
+**Signature:**
+
+```typescript
+sizeEnd?: number;
+```

package/docs/server.particleemitteroptions.sizeendvariance.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; [ParticleEmitterOptions](./server.particleemitteroptions.md) &gt; [sizeEndVariance](./server.particleemitteroptions.sizeendvariance.md)
+
+## ParticleEmitterOptions.sizeEndVariance property
+
+The size variance at the end of an emitted particle's lifetime.
+
+**Signature:**
+
+```typescript
+sizeEndVariance?: number;
+```

package/docs/server.particleemitteroptions.sizestart.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; [ParticleEmitterOptions](./server.particleemitteroptions.md) &gt; [sizeStart](./server.particleemitteroptions.sizestart.md)
+
+## ParticleEmitterOptions.sizeStart property
+
+The size at the start of an emitted particle's lifetime.
+
+**Signature:**
+
+```typescript
+sizeStart?: number;
+```

package/docs/server.particleemitteroptions.sizestartvariance.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; [ParticleEmitterOptions](./server.particleemitteroptions.md) &gt; [sizeStartVariance](./server.particleemitteroptions.sizestartvariance.md)
+
+## ParticleEmitterOptions.sizeStartVariance property
+
+The size variance at the start of an emitted particle's lifetime.
+
+**Signature:**
+
+```typescript
+sizeStartVariance?: number;
+```

package/docs/server.sceneuimanager.getallsceneuis.md

@@ -9,8 +9,44 @@ 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,71 @@
+<!-- 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,55 @@
+<!-- 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,55 @@
+<!-- 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,71 @@
+<!-- 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,71 @@
+<!-- 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.
+