feat: add initial People Playground mod development kit
This commit is contained in:
58
extracted_wiki_content/internalReference/poolgenerator.txt
Normal file
58
extracted_wiki_content/internalReference/poolgenerator.txt
Normal file
@@ -0,0 +1,58 @@
|
||||
URL: https://wiki.studiominus.nl/internalReference/PoolGenerator.html
|
||||
Title: People Playground Modding - PoolGenerator
|
||||
==================================================
|
||||
|
||||
public class PoolGenerator
|
||||
Inherits MonoBehaviour
|
||||
Generates object pools when requested
|
||||
Fields
|
||||
public bool Activated
|
||||
No description provided
|
||||
|
||||
public float MaximumDistance
|
||||
No description provided
|
||||
|
||||
public LineRenderer LineRenderer
|
||||
[SkipSerialisation]
|
||||
No description provided
|
||||
|
||||
public EdgeCollider2D EdgeCollider
|
||||
[SkipSerialisation]
|
||||
No description provided
|
||||
|
||||
public AudioSource AudioSource
|
||||
[SkipSerialisation]
|
||||
No description provided
|
||||
|
||||
public LayerMask HitLayers
|
||||
[SkipSerialisation]
|
||||
No description provided
|
||||
|
||||
public uint PoolSize
|
||||
Value to set for ObjectPoolBehaviour.MaxPoolSize for each generated pool
|
||||
|
||||
public float PoolInactivityThreshold
|
||||
Value to set for ObjectPoolBehaviour.InactivityThresholdInSeconds for each generated pool
|
||||
|
||||
Properties
|
||||
public static PoolGenerator Instance { get; private set; }
|
||||
Main instance of the singleton
|
||||
|
||||
Methods
|
||||
void Start()
|
||||
No description provided
|
||||
|
||||
public void Use(ActivationPropagation activation)
|
||||
No description provided
|
||||
|
||||
void SetNewDistance(float distance)
|
||||
No description provided
|
||||
|
||||
public bool GetFor(GameObject prefab, out ObjectPoolBehaviour pool)
|
||||
Returns true if a pool has been found for the given prefab and outputs said pool in the parameter
|
||||
|
||||
public ObjectPoolBehaviour Ensure(GameObject prefab)
|
||||
Ensure there is a pool for the given prefab
|
||||
|
||||
public GameObject RequestPrefab(GameObject originalPrefab, Vector2 position)
|
||||
Request an object from a pool. If the pool exists, it will simply be requested using ObjectPoolBehaviour.Request(Vector2). If it doesn't exist, it'll be created first.
|
||||
Reference in New Issue
Block a user