ScriptComponentClass Interface Reference

Inheritance diagram for ScriptComponentClass:

Static Public Member Functions
static bool	DependsOn (string className)
	Implement this if you need to enforce certain creation order of components.
static array< TypeName >	Requires (IEntityComponentSource src)
	Implement this if you need to enforce some other component type.
static array< TypeName >	CannotCombine (IEntityComponentSource src)
	Implement this if you need to disallow to concurrent usage with the other type.

Additional Inherited Members
Public Member Functions inherited from GenericComponentClass
void	GenericComponentClass (IEntityComponentSource componentSource, IEntitySource parentSource, IEntitySource prefabSource)

Member Function Documentation

CannotCombine()

static array< TypeName > ScriptComponentClass.CannotCombine ( IEntityComponentSource src )

static

Implement this if you need to disallow to concurrent usage with the other type.

Returns

array of component types

static override array<typename> CannotCombine(IEntityComponentSource src)
{
    return {MyOtherComponent};
}

DependsOn()

static bool ScriptComponentClass.DependsOn ( string className )

static

Implement this if you need to enforce certain creation order of components.

Parameters

className

- name of other Component class static override bool DependsOn(string className) { if (className.ToType() == MyOtherComponent) return true; return false; }

Requires()

static array< TypeName > ScriptComponentClass.Requires ( IEntityComponentSource src )

static

Implement this if you need to enforce some other component type.

Returns

array of component types

static override array<typename> Requires(IEntityComponentSource src)
{
    return {MyOtherComponent};
}

---

The documentation for this interface was generated from the following file:

• GameLib/generated/ScriptComponentClass.c