TextStudioReactionLease
public readonly struct TextStudioReactionLeaseBackend-owned retained output. Slots are versioned; releasing a copied handle twice must be harmless.
Constructors
Section titled “Constructors”
TextStudioReactionLease(ITextStudioReactionCaptureProvider, int, uint)
Section titled “TextStudioReactionLease(ITextStudioReactionCaptureProvider, int, uint)”public TextStudioReactionLease(ITextStudioReactionCaptureProvider owner, int slot, uint version)Creates a versioned retained-output lease for a provider slot.
Parameters
| Name | Type |
|---|---|
owner |
TextStudio.ITextStudioReactionCaptureProvider |
slot |
System.Int32 |
version |
System.UInt32 |
Methods
Section titled “Methods”
TryGetAnchor(out TextStudioReactionAnchor)
Section titled “TryGetAnchor(out TextStudioReactionAnchor)”public bool TryGetAnchor(out TextStudioReactionAnchor anchor)Attempts to resolve this retained output’s current anchor when the lease is valid.
Parameters
| Name | Type |
|---|---|
anchor |
TextStudio.TextStudioReactionAnchor |
Returns
System.Boolean
Release()
Section titled “Release()”public void Release()Releases this retained output through its owning provider when the lease is valid.
TrySubmit(in TextStudioReactionVisualSample)
Section titled “TrySubmit(in TextStudioReactionVisualSample)”public bool TrySubmit(in TextStudioReactionVisualSample sample)Attempts to apply a visual sample when this valid lease supports retained visual output.
Parameters
| Name | Type |
|---|---|
sample |
TextStudio.TextStudioReactionVisualSample |
Returns
System.Boolean
TryGetRetainedWorldObject(out GameObject, out Vector3, out Vector3)
Section titled “TryGetRetainedWorldObject(out GameObject, out Vector3, out Vector3)”public bool TryGetRetainedWorldObject(out GameObject output, out Vector3 linearVelocity, out Vector3 angularVelocity)Attempts to obtain this capture’s retained world object and launch velocities when its provider supports them.
Parameters
| Name | Type |
|---|---|
output |
UnityEngine.GameObject |
linearVelocity |
UnityEngine.Vector3 |
angularVelocity |
UnityEngine.Vector3 |
Returns
System.Boolean
TrySubmitAppearance(Vector3, float, Color32)
Section titled “TrySubmitAppearance(Vector3, float, Color32)”public bool TrySubmitAppearance(Vector3 scale, float alpha, Color32 tint)Attempts to apply scale, opacity, and tint when this valid lease supports retained world-object output.
Parameters
| Name | Type |
|---|---|
scale |
UnityEngine.Vector3 |
alpha |
System.Single |
tint |
UnityEngine.Color32 |
Returns
System.Boolean
Properties
Section titled “Properties”
IsValid
Section titled “IsValid”public bool IsValid { get; }Returns
System.Boolean
SupportsVisualOutput
Section titled “SupportsVisualOutput”public bool SupportsVisualOutput { get; }Returns
System.Boolean