Skip to content

TextStudio3DCompanionControl

ClassTextStudio.ThreeDTextStudio.3D
public sealed class TextStudio3DCompanionControl

Exclusive, instance-owned control of a source effect family's build progress or discharge intensity.

public void SetProgress(float progress)

Updates normalized companion progress and notifies the host when the value changes. Progress scales the authored amount or intensity: 0 shows none of the effect and 1 shows it as authored.

Parameters

NameType
progressSystem.Single
public void Dispose()

Releases exclusive control of this companion family back to the host.

public TextStudio3DCompanionFamily Family { get; }

Returns

TextStudio.ThreeD.TextStudio3DCompanionFamily

public float Progress { get; }

Returns

System.Single

public bool IsDisposed { get; }

Returns

System.Boolean