You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
46 lines
1.5 KiB
46 lines
1.5 KiB
using gaemstone.ECS; |
|
using static gaemstone.Flecs.Core; |
|
|
|
namespace gaemstone; |
|
|
|
[Module] |
|
public partial class Doc |
|
{ |
|
[Tag] |
|
public struct Relation { } |
|
|
|
/// <summary> |
|
/// Tags are just <see cref="Flecs.Core.Component"/>s with 0 size. |
|
/// This functions as a special entity that holds the appearance for tags |
|
/// used by the entity inspector, and is not actually added to any entity. |
|
/// Not related to <see cref="Flecs.Core.Tag"/> in any way. |
|
/// </summary> |
|
[Tag] |
|
public struct Tag { } |
|
|
|
/// <summary> |
|
/// Added to entities that represent a unique type of entity that should |
|
/// be displayed uniquely in the entity inspector. If an entity is tagged |
|
/// with such a display type entity, it too will be shown differently. |
|
/// </summary> |
|
/// <details> |
|
/// <p> |
|
/// Examples of such display types include: |
|
/// <list> |
|
/// <item> <see cref="Flecs.Core.Module"/> </item> |
|
/// <item> <see cref="Flecs.Core.Component"/> </item> |
|
/// <item> <see cref="Flecs.Core.Observer"/> </item> |
|
/// <item> <see cref="Flecs.System.System"/> </item> |
|
/// <item> <see cref="gaemstone.Doc.Relation"/> </item> |
|
/// <item> <see cref="gaemstone.Doc.Tag"/> </item> |
|
/// </list> |
|
/// </p> |
|
/// <p> |
|
/// Used in conjuction with components and relations such as |
|
/// (<see cref="Flecs.Doc.Description"/>, <see cref="Flecs.Doc.Color"/>) |
|
/// to specify the appearance of this display type in the entity inspector. |
|
/// </p> |
|
/// </details> |
|
[Tag] |
|
public struct DisplayType { } |
|
}
|
|
|