Skip to content

TextStudioReactionLease

StructTextStudioTextStudio
public readonly struct TextStudioReactionLease

Backend-owned retained output. Slots are versioned; releasing a copied handle twice must be harmless.

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

NameType
ownerTextStudio.ITextStudioReactionCaptureProvider
slotSystem.Int32
versionSystem.UInt32

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

NameType
anchorTextStudio.TextStudioReactionAnchor

Returns

System.Boolean

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

NameType
sampleTextStudio.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

NameType
outputUnityEngine.GameObject
linearVelocityUnityEngine.Vector3
angularVelocityUnityEngine.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

NameType
scaleUnityEngine.Vector3
alphaSystem.Single
tintUnityEngine.Color32

Returns

System.Boolean

public bool IsValid { get; }

Returns

System.Boolean

public bool SupportsVisualOutput { get; }

Returns

System.Boolean