Skip to content

Game.Prefabs.UITutorialGroupData

Assembly: Assembly-CSharp.dll
Namespace: Game.Prefabs

Type: struct

Base: System.ValueType, Unity.Entities.IComponentData, Unity.Entities.IQueryTypeParameter

Summary:
UITutorialGroupData is an empty/tag component used by the game's ECS to mark entities that represent a UI tutorial group. It carries no runtime payload (no logical fields) and is intended purely as a marker so systems and queries can identify or filter tutorial-group entities. The type is decorated with [StructLayout(LayoutKind.Sequential, Size = 1)] to give it a non-zero size at the CLR level, avoiding issues some runtimes might have with zero-sized structs while still being effectively a tag in Unity's Entities workflow.

Fields

  • This struct declares no instance fields.
    This is a tag (marker) component. There are no stored data members — it exists only to label entities.

Properties

  • None
    There are no properties on this type.

Constructors

  • public UITutorialGroupData()
    The type uses the default parameterless constructor (implicitly provided). Because it contains no fields, construction is trivial.

Methods

  • None
    No methods are defined on this component type.

Usage Example

// Add the tag to an existing entity
entityManager.AddComponentData(entity, new UITutorialGroupData());

// Alternatively create an archetype that includes the tag
var archetype = entityManager.CreateArchetype(typeof(UITutorialGroupData), /* other component types */);
var e = entityManager.CreateEntity(archetype);

// Query for entities that are tagged with UITutorialGroupData
Entities
    .WithAll<UITutorialGroupData>()
    .ForEach((Entity entity) =>
    {
        // Handle tutorial-group UI logic for the entity
    })
    .Run();

// Check if a particular entity has the tag
bool isTutorialGroup = entityManager.HasComponent<UITutorialGroupData>(entity);

Notes: - Use this component when you need to mark or filter entities that act as UI tutorial groups. Systems can efficiently include or exclude these entities via queries. - Although the struct is empty, the StructLayout attribute fixes a small non-zero size at the CLR level; for ECS usage it behaves as a tag component.