SpawnModule

ClassTextStudio.ThreeDTextStudio.3D

public class SpawnModule : Module3DBase, ITextStudio3DOutgoingHandoffModule

Spawns pooled objects at generated glyph positions after mesh assembly.

Fields

MaximumInstanceCount

public const int MaximumInstanceCount = 256

Returns

System.Int32

Methods

OnAttach(TextStudio3DText)

public override void OnAttach(TextStudio3DText host)

Called once when the module is first attached to a 3D text component.

Parameters

Name	Type
host	TextStudio.ThreeD.TextStudio3DText

OnDetach(TextStudio3DText)

public override void OnDetach(TextStudio3DText host)

Called when the module is removed from a 3D text component.

Parameters

Name	Type
host	TextStudio.ThreeD.TextStudio3DText

PostMeshAssembly(ModuleContext)

public override void PostMeshAssembly(ModuleContext context)

Called after mesh assembly. Use to apply final mesh modifications.

Parameters

Name	Type
context	TextStudio.ThreeD.ModuleContext

UpdateVisual(in TextStudio3DVisualModuleContext)

public override void UpdateVisual(in TextStudio3DVisualModuleContext context)

Observes final animated glyph state after the renderer has applied the frame.

Parameters

Name	Type
context	TextStudio.ThreeD.TextStudio3DVisualModuleContext

OnInactive(TextStudio3DText)

public override void OnInactive(TextStudio3DText host)

Called after assembly when an attached post-assembly module is disabled. Lifecycle modules can use this to hide or return previously created output without destroying pools.

Parameters

Name	Type
host	TextStudio.ThreeD.TextStudio3DText

CanHandleOutgoingHandoff(TextStudio3DText)

public bool CanHandleOutgoingHandoff(TextStudio3DText host)

Returns whether this module can spawn outgoing-handoff effects for the supplied host.

Parameters

Name	Type
host	TextStudio.ThreeD.TextStudio3DText

Returns

System.Boolean

TryHandleOutgoingHandoff(in TextStudio3DOutgoingHandoffContext)

public bool TryHandleOutgoingHandoff(in TextStudio3DOutgoingHandoffContext context)

Spawns the configured effects for glyphs participating in an outgoing text handoff.

Parameters

Name	Type
context	TextStudio.ThreeD.TextStudio3DOutgoingHandoffContext

Returns

System.Boolean

Constructors

SpawnModule()

public SpawnModule()

Properties

Prefab

public GameObject Prefab { get; }

Returns

UnityEngine.GameObject

Triggers

public TextStudio3DSpawnTrigger Triggers { get; }

Returns

TextStudio.ThreeD.TextStudio3DSpawnTrigger

Socket

public TextStudio3DSocketKind Socket { get; }

Returns

TextStudio.ThreeD.TextStudio3DSocketKind

NamedSocket

public string NamedSocket { get; }

Returns

System.String

Attachment

public TextStudio3DSpawnAttachment Attachment { get; }

Returns

TextStudio.ThreeD.TextStudio3DSpawnAttachment

SpawnDelay

public float SpawnDelay { get; }

Returns

System.Single

Lifetime

public float Lifetime { get; }

Returns

System.Single

ParentToText

public bool ParentToText { get; }

Returns

System.Boolean

MaxInstances

public int MaxInstances { get; }

Returns

System.Int32

LocalOffset

public Vector3 LocalOffset { get; }

Returns

UnityEngine.Vector3

LocalRotation

public Quaternion LocalRotation { get; }

Returns

UnityEngine.Quaternion

LocalScale

public Vector3 LocalScale { get; }

Returns

UnityEngine.Vector3

ExecutionStages

public override ModuleExecutionStage ExecutionStages { get; }

Pipeline callbacks used by this module. Typed capability interfaces infer their exact stages; modules using raw callbacks must override this property explicitly.

Returns

TextStudio.ThreeD.ModuleExecutionStage

RequiresUncachedGeometry

public override bool RequiresUncachedGeometry { get; }

Whether this module needs isolated glyph geometry instead of shared cached buffers. Contour and post-geometry modules normally do; lifecycle-only modules normally do not.

Returns

System.Boolean

Roles

public override TextStudio3DModuleRole Roles { get; }

Returns

TextStudio.ThreeD.TextStudio3DModuleRole

RequiredMeshChannels

public override TextStudio3DMeshChannels RequiredMeshChannels { get; }

Returns

TextStudio.ThreeD.TextStudio3DMeshChannels

BoundsBehavior

public override TextStudio3DBoundsBehavior BoundsBehavior { get; }

Returns

TextStudio.ThreeD.TextStudio3DBoundsBehavior

GeometryImpact

public override TextStudio3DGeometryImpact GeometryImpact { get; }

Returns

TextStudio.ThreeD.TextStudio3DGeometryImpact