TextStudioReactionUIParticleLease
public readonly struct TextStudioReactionUIParticleLeaseA versioned output owned by the active UI renderer.
Constructors
Section titled “Constructors”
TextStudioReactionUIParticleLease(ITextStudioReactionUIParticleOutput, int, uint)
Section titled “TextStudioReactionUIParticleLease(ITextStudioReactionUIParticleOutput, int, uint)”public TextStudioReactionUIParticleLease(ITextStudioReactionUIParticleOutput owner, int slot, uint version)Creates a versioned UI particle lease for an output provider slot.
Parameters
| Name | Type |
|---|---|
owner |
TextStudio.ITextStudioReactionUIParticleOutput |
slot |
System.Int32 |
version |
System.UInt32 |
Methods
Section titled “Methods”
TrySet(int, in TextStudioReactionUIParticle)
Section titled “TrySet(int, in TextStudioReactionUIParticle)”public bool TrySet(int index, in TextStudioReactionUIParticle particle)Attempts to write a particle at the specified index while this lease is valid.
Parameters
| Name | Type |
|---|---|
index |
System.Int32 |
particle |
TextStudio.TextStudioReactionUIParticle |
Returns
System.Boolean
Commit()
Section titled “Commit()”public bool Commit()Publishes the particle values written through this valid lease.
Returns
System.Boolean
Release()
Section titled “Release()”public void Release()Releases the particle output through its owner when this lease is valid.
Properties
Section titled “Properties”
IsValid
Section titled “IsValid”public bool IsValid { get; }Returns
System.Boolean