SpawnModule
[CreateAssetMenu(fileName = "New Glyph Prefab Spawner", menuName = "Text Studio/3D/Modules/Glyph Prefab Spawner", order = 113)]public class SpawnModule : Module3DBaseSpawns pooled objects at generated glyph positions after mesh assembly.
Fields
Section titled “Fields”
MaximumInstanceCount
Section titled “MaximumInstanceCount”public const int MaximumInstanceCount = 256Returns
System.Int32
Methods
Section titled “Methods”
OnAttach(TextStudio3DText)
Section titled “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)
Section titled “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)
Section titled “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 |
OnInactive(TextStudio3DText)
Section titled “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 |
Constructors
Section titled “Constructors”
SpawnModule()
Section titled “SpawnModule()”public SpawnModule()Properties
Section titled “Properties”
Prefab
Section titled “Prefab”public GameObject Prefab { get; }Returns
UnityEngine.GameObject
SpawnDelay
Section titled “SpawnDelay”public float SpawnDelay { get; }Returns
System.Single
Lifetime
Section titled “Lifetime”public float Lifetime { get; }Returns
System.Single
ParentToText
Section titled “ParentToText”public bool ParentToText { get; }Returns
System.Boolean
MaxInstances
Section titled “MaxInstances”public int MaxInstances { get; }Returns
System.Int32
LocalOffset
Section titled “LocalOffset”public Vector3 LocalOffset { get; }Returns
UnityEngine.Vector3
LocalRotation
Section titled “LocalRotation”public Quaternion LocalRotation { get; }Returns
UnityEngine.Quaternion
LocalScale
Section titled “LocalScale”public Vector3 LocalScale { get; }Returns
UnityEngine.Vector3
ExecutionStages
Section titled “ExecutionStages”public override ModuleExecutionStage ExecutionStages { get; }Pipeline callbacks used by this module. The default is conservative so existing custom modules keep receiving every callback until they declare narrower requirements.
Returns
TextStudio.ThreeD.ModuleExecutionStage
RequiresUncachedGeometry
Section titled “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
public override TextStudio3DModuleRole Roles { get; }Returns
TextStudio.ThreeD.TextStudio3DModuleRole
RequiredMeshChannels
Section titled “RequiredMeshChannels”public override TextStudio3DMeshChannels RequiredMeshChannels { get; }Returns
TextStudio.ThreeD.TextStudio3DMeshChannels
BoundsBehavior
Section titled “BoundsBehavior”public override TextStudio3DBoundsBehavior BoundsBehavior { get; }Returns
TextStudio.ThreeD.TextStudio3DBoundsBehavior
GeometryImpact
Section titled “GeometryImpact”public override TextStudio3DGeometryImpact GeometryImpact { get; }Returns
TextStudio.ThreeD.TextStudio3DGeometryImpact