Table of Contents

Class WorldTextProcessor

Namespace
Stride.CommunityToolkit.Rendering.Text
Assembly
Stride.CommunityToolkit.dll

Keeps track of every WorldTextComponent in the scene for the world text renderer.

public class WorldTextProcessor : EntityProcessor<WorldTextComponent, WorldTextRenderData>
Inheritance
WorldTextProcessor
Inherited Members

Remarks

Registered automatically through the DefaultEntityComponentProcessor attribute on the component, so nothing needs to add it. Collection through a processor covers the whole entity hierarchy and gives each component's cached measurement a lifetime tied to the component itself.

Properties

Texts

Gets every world text currently in the scene, in no particular order.

public IReadOnlyList<WorldTextRenderData> Texts { get; }

Property Value

IReadOnlyList<WorldTextRenderData>

Methods

GenerateComponentData(Entity, WorldTextComponent)

protected override WorldTextRenderData GenerateComponentData(Entity entity, WorldTextComponent component)

Parameters

entity Entity
component WorldTextComponent

Returns

WorldTextRenderData

IsAssociatedDataValid(Entity, WorldTextComponent, WorldTextRenderData)

protected override bool IsAssociatedDataValid(Entity entity, WorldTextComponent component, WorldTextRenderData associatedData)

Parameters

entity Entity
component WorldTextComponent
associatedData WorldTextRenderData

Returns

bool

OnEntityComponentAdding(Entity, WorldTextComponent, WorldTextRenderData)

protected override void OnEntityComponentAdding(Entity entity, WorldTextComponent component, WorldTextRenderData data)

Parameters

entity Entity
component WorldTextComponent
data WorldTextRenderData

OnEntityComponentRemoved(Entity, WorldTextComponent, WorldTextRenderData)

protected override void OnEntityComponentRemoved(Entity entity, WorldTextComponent component, WorldTextRenderData data)

Parameters

entity Entity
component WorldTextComponent
data WorldTextRenderData