目录

IComponents

Class/Struct Info

public struct IComponents : IEnumerable<ComponentType>

一组组件类型的集合,主要用于为各模块的组件类型设置或批处理输入组件集合。

Property Summary

Name

Type

Description

Count

int

返回这一组组件类型的数量。

Sample Code
// 创建包含PgdPosition组件的组件类型集合
var componentSet = IComponents.Get<PgdPosition>();
// Count表示集合中有几种组件类型,该示例中为1
componentSet.Count;

Method Summary

Qualifier and Type

Method Name and Description

IComponentsEnumerator

GetEnumerator()

获取IComponents枚举器,用于遍历这组组件类型,foreach自动调用。

bool

HasAll(in IComponents components)

判断当前组件类型集合是否包含输入的组件类型集合。

bool

HasAny(in IComponents components)

判断当前组件类型集合是否拥有输入的组件类型集合中任意组件类型。

void

Add<T>()

将指定组件类型添加到组件类型集合中。

void

Add(in IComponents components)

将输入的组件类型集合包含的所有组件类型,添加到当前组件类型集合中。

void

Remove<T>()

将指定组件类型从组件类型集合中移除。

void

Remove(in IComponents components)

移除当前组件类型集合中,与输入组件类型集合中相同的组件类型。

string

ToString()

将当前组件类型集合的详细信息以字符串形式返回。

IComponents

Get<T1, ...>()

将输入的一组泛型组件转换成IComponents表达输出,最多支持10个泛型。

bool

Has<T1, ...>()

判断当前组件类型集合是否包含指定泛型,最多支持10个泛型。

IComponents

GetSharedSet<TS1, ...>()

将输入的一组泛型共享组件转换成IComponents表达输出,最多支持10个泛型。

Methods

[h2]GetEnumerator

Method

readonly IComponentsEnumerator GetEnumerator()

只读方法。

获取IComponents枚举器,用于遍历这组组件类型,foreach自动调用。

Return

Type

Description

IComponentsEnumerator

IComponents枚举器。

Sample Code
// 创建包含PgdPosition组件的组件类型集合
var componentSet = IComponents.Get<PgdPosition>();

// foreach自动调用GetEnumerator
foreach(var componentType in componentSet)
{
    // 遍历组件类型
}

[h2]HasAll

Method

readonly bool HasAll(in IComponents components)

只读方法。

判断当前组件类型集合是否包含输入的组件类型集合。

Parameters

Name

Type

Description

components

IComponents

组件类型集合。

Return

Type

Description

bool

  • true:表示当前组完全包含输入组。
  • false:表示当前组不完全包含输入组。
Sample Code
// 创建组件类型集合
var componentSet1 = IComponents.Get<PgdPosition>();
var componentSet2 = IComponents.Get<PgdPosition, PgdRotation>();

// 判断当前集合是否完全包含另一集合
componentSet2.HasAll(componentSet1); // 此时返回true

[h2]HasAny

Method

readonly bool HasAny(in IComponents components)

只读方法。

判断当前组件类型集合是否拥有输入的组件类型集合中任意组件类型。

Parameters

Name

Type

Description

components

IComponents

组件类型集合。

Return

Type

Description

bool

  • true:表示当前组包含输入组中至少一种类型。
  • false:表示当前组完全不包含输入组。
Sample Code
// 创建组件类型集合
var componentSet1 = IComponents.Get<PgdPosition>();
var componentSet2 = IComponents.Get<PgdPosition, PgdRotation>();

// 判断当前集合与另一集合是否有任意相同组件类型
componentSet1.HasAny(ComponentSet2); // 此时返回true

[h2]Add<T>

Method

void Add<T>()

将指定组件类型添加到组件类型集合中。

Sample Code
// 创建组件类型集合
var componentSet1 = IComponents.Get<PgdPosition, PgdRotation>(); // 此时集合中包含PgdPosition和PgdRotation
// 给集合添加指定组件,仅支持一个泛型组件
componentSet1.Add<PgdScale>(); // 此时集合中包含PgdPosition、PgdRotation和PgdScale

[h2]Add

Method

void Add(in IComponents components)

将输入的组件类型集合包含的所有组件类型,添加到当前组件类型集合中。

Parameters

Name

Type

Description

components

IComponents

组件类型集合。

Sample Code
// 创建组件类型集合
var componentSet1 = IComponents.Get<PgdPosition>();
var componentSet2 = IComponents.Get<PgdPosition, PgdRotation>();

// 将另一个集合添加到当前集合中,结果等于两个集合的并集,重复组件没有影响
componentSet1.Add(componentSet2); // 此时componentSet1包含PgdPosition和PgdRotation

[h2]Remove<T>

Method

void Remove<T>()

将指定组件类型从组件类型集合中移除。

Sample Code
// 创建组件类型集合
var componentSet1 = IComponents.Get<PgdPosition, PgdRotation>(); // 此时集合中包含PgdPosition和PgdRotation
// 给集合添加指定组件,仅支持一个泛型组件
componentSet1.Remove<PgdRotation>(); // 此时集合中包含PgdPosition

[h2]Remove

Method

void Remove(in IComponents components)

移除当前组件类型集合中,与输入组件类型集合中相同的组件类型。

Parameters

Name

Type

Description

components

IComponents

组件类型集合。

Sample Code
// 创建组件类型集合
var componentSet1 = IComponents.Get<PgdPosition, PgdScale>();
var componentSet2 = IComponents.Get<PgdPosition, PgdRotation>();

// 将另一个集合从当前集合中移除,仅移除共同组件,非共同组件没有影响
componentSet1.Remove(componentSet2); // 此时componentSet1包含PgdScale

[h2]ToString

Method

string ToString()

将当前组件类型集合的详细信息以字符串形式返回,打印的组件和标签名字均会带命名域。

Return

Type

Description

string

当前组件类型集合的详细信息。

Sample Code
// 创建组件类型集合
var componentSet1 = IComponents.Get<PgdPosition, PgdScale>();

// 打印集合信息。预设组件/标签命名域为"Pgd.",自定义组件/标签/共享组件根据实际情况而定
componentSet1.ToString(); // 此时打印结果为"Components: [Pgd.PgdPosition, Pgd.PgdScale]"

[h2]Get<T1, ...>

Method

static IComponents Get<T1, ...>()

静态方法。

将输入的一组泛型组件转换成IComponents表达输出,最多支持10个泛型。

T为IComponent。

Return

Type

Description

IComponents

一组泛型的IComponents表达。

Sample Code
// 创建组件类型集合,最多支持一次输入10个组件
var componentSet1 = IComponents.Get<PgdPosition, PgdScale>(); // 包含PgdPosition和PgdScale的集合

[h2]Has<T1, ...>

Method

readonly bool Has<T1, ...>()

只读方法。

判断当前组件类型集合是否包含指定泛型,最多支持10个泛型。

T为IComponent。

Return

Type

Description

bool

  • true:表示当前IComponents包含所有指定泛型组件类型。
  • false:表示当前IComponents不完全包含指定泛型组件类型。
Sample Code
// 创建组件类型集合
var componentSet1 = IComponents.Get<PgdPosition, PgdScale>();
// 判断集合是否包含指定组件类型,最多支持一次输入10个组件
componentSet1.Has<PgdPosition>(); // true
// 输入多个组件时,需要全包含才会返回true,否则为false
componentSet1.Has<PgdRotation, PgdScale>(); // false

[h2]GetSharedSet<TS1, ...>

Method

static IComponents GetSharedSet<TS1, ...>()

静态方法。

将输入的一组泛型共享组件转换成IComponents表达输出,最多支持10个泛型。

TS为IShared。

Return

Type

Description

IComponents

一组泛型的IComponents表达。

Sample Code
// 创建共享组件类型集合,最多支持一次输入10个组件
var sharedComponentSet1 = IComponents.GetSharedSet<SharedComponent1, SharedComponent2>(); // 包含SharedComponent1和SharedComponent2的集合