Enfusion Script API
Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
ScriptComponentClass Interface Reference
Inheritance diagram for ScriptComponentClass:
[legend]

Static Public Member Functions

static bool DependsOn (string className)
 Implement this if you need to enforce certain creation order of components.
 
static array< TypeNameRequires (IEntityComponentSource src)
 Implement this if you need to enforce some other component type.
 
static array< TypeNameCannotCombine (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
{
return {MyOtherComponent};
}
Definition: IEntityComponentSource.c:13
static array< TypeName > CannotCombine(IEntityComponentSource src)
Implement this if you need to disallow to concurrent usage with the other type.
Definition: Types.c:150

◆ 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 ComponentClass class
static override bool DependsOn(string className)
{
if (className == "MyOtherComponentClass")
return true;
return false;
}
static bool DependsOn(string className)
Implement this if you need to enforce certain creation order of components.

◆ 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
{
return {MyOtherComponent};
}
static array< TypeName > Requires(IEntityComponentSource src)
Implement this if you need to enforce some other component type.

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