NikosAssets.Modulize 0.1.1
Loading...
Searching...
No Matches
NikosAssets.Modulize.BaseCompositeModule< TBaseModule > Class Template Referenceabstract

Stores the specified module type in lists, preparing for execution. More...

Public Member Functions

override void AwakeInit ()
 Calls AwakeInit() for every assigned module.
override void StartInit ()
 Calls StartInit() for every assigned module.
override void Destroy ()
 Calls Destroy() for every assigned module.
override void Enable ()
 Calls Enable() for every assigned module.
override void Disable ()
 Calls Disable() for every assigned module.
override void UpdateTick (float deltaTime)
 Calls UpdateTick() for every assigned module in _modulesToUpdate.
override void FixedTick (float deltaTime)
 Calls FixedTick() for every assigned module in _modulesToFixedUpdate.
override void LateTick (float deltaTime)
 Calls LateTick() for every assigned module in _modulesToLateUpdate.
void AddModuleToUpdate (TBaseModule moduleToUpdate)
 Add the module to _modulesToUpdate.
void AddModuleToFixedUpdate (TBaseModule moduleToFixedUpdate)
 Add the module to _modulesToFixedUpdate.
void AddModuleToLateUpdate (TBaseModule moduleToLateUpdate)
 Add the module to _modulesToLateUpdate.
void RemoveModuleFromUpdate (TBaseModule moduleToUpdate)
 Remove the module from _modulesToUpdate.
void RemoveModuleFromFixedUpdate (TBaseModule moduleToFixedUpdate)
 Remove the module from _modulesToFixedUpdate.
void RemoveModuleFromLateUpdate (TBaseModule moduleToLateUpdate)
 Remove the module from _modulesToLateUpdate.
void RemoveModuleFromUpdate (int atIndex)
 Remove the module from _modulesToUpdate at index.
void RemoveModuleFromFixedUpdate (int atIndex)
 Remove the module from _modulesToFixedUpdate at index.
void RemoveModuleFromLateUpdate (int atIndex)
 Remove the module from _modulesToLateUpdate at index.
void RemoveModule (TBaseModule module, UpdateType updateType)
 Remove the module from at least one of the lists (multiple possible set it up this way)
void ClearModules (UpdateType updateType)
 Clears the modules from this composite module (not destroying them, just removing them from the list(s))
void InsertModuleToUpdate (TBaseModule moduleToUpdate, int index)
 Inserts and replaced the module at the given index of the _modulesToUpdate list.
void InsertModuleToFixedUpdate (TBaseModule moduleToFixedUpdate, int index)
 Inserts and replaced the module at the given index of the _modulesToFixedUpdate list.
void InsertModuleToLateUpdate (TBaseModule moduleToLateUpdate, int index)
 Inserts and replaced the module at the given index of the _modulesToLateUpdate list.
List< TBaseModuleToUpdate > GetModulesByModuleType< TBaseModuleToUpdate > ()
 Get the module matching the type from any list.
List< TBaseModuleToUpdate > GetModulesToUpdateByModuleType< TBaseModuleToUpdate > ()
 Get the module matching the type from the _modulesToUpdate list.
List< TBaseModuleToFixedUpdate > GetModulesToFixedUpdateByModuleType< TBaseModuleToFixedUpdate > ()
 Get the module matching the type from the _modulesToFixedUpdate list.
List< TBaseModuleToLateUpdate > GetModulesToLateUpdateByModuleType< TBaseModuleToLateUpdate > ()
 Get the module matching the type from the _modulesToLateUpdate list.
Public Member Functions inherited from NikosAssets.Modulize.BaseModule
void AwakeInit ()
 Your (optional) Awake logic.
void StartInit ()
 Your (optional) Start logic.
void Destroy ()
 Your (optional) OnDestroy logic.
void Enable ()
 Your (optional) OnEnable logic.
void Disable ()
 Your (optional) OnDisable logic.
void UpdateTick (float deltaTime)
 Your (optional) Update logic.
void FixedTick (float deltaTime)
 Your (optional) FixedUpdate logic.
void LateTick (float deltaTime)
 Your (optional) LateUpdate logic.

Protected Attributes

List< TBaseModule > _modulesToUpdate = new List<TBaseModule>()
List< TBaseModule > _modulesToFixedUpdate = new List<TBaseModule>()
List< TBaseModule > _modulesToLateUpdate = new List<TBaseModule>()

Properties

List< TBaseModule > ModulesToUpdate [get]
 Direct access to the modules for more control over the list.
List< TBaseModule > ModulesToFixedUpdate [get]
 Direct access to the modules for more control over the list.
List< TBaseModule > ModulesToLateUpdate [get]
 Direct access to the modules for more control over the list.

Additional Inherited Members

Public Types inherited from NikosAssets.Modulize.BaseModule
enum  UpdateType { Update = 1 , FixedUpdate = 2 , LateUpdate = 4 }

Detailed Description

Stores the specified module type in lists, preparing for execution.

Template Parameters
TBaseModule
Type Constraints
TBaseModule :BaseModule 

Member Function Documentation

◆ AddModuleToFixedUpdate()

void NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.AddModuleToFixedUpdate ( TBaseModule moduleToFixedUpdate)

Add the module to _modulesToFixedUpdate.

Parameters
moduleToFixedUpdate

◆ AddModuleToLateUpdate()

void NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.AddModuleToLateUpdate ( TBaseModule moduleToLateUpdate)

Add the module to _modulesToLateUpdate.

Parameters
moduleToLateUpdate

◆ AddModuleToUpdate()

void NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.AddModuleToUpdate ( TBaseModule moduleToUpdate)

Add the module to _modulesToUpdate.

Parameters
moduleToUpdate

◆ ClearModules()

void NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.ClearModules ( UpdateType updateType)

Clears the modules from this composite module (not destroying them, just removing them from the list(s))

Parameters
updateTypeWhich list(s) to clear?

◆ GetModulesByModuleType< TBaseModuleToUpdate >()

List< TBaseModuleToUpdate > NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.GetModulesByModuleType< TBaseModuleToUpdate > ( )

Get the module matching the type from any list.

Template Parameters
TBaseModuleToUpdate
Returns
Type Constraints
TBaseModuleToUpdate :TBaseModule 

◆ GetModulesToFixedUpdateByModuleType< TBaseModuleToFixedUpdate >()

List< TBaseModuleToFixedUpdate > NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.GetModulesToFixedUpdateByModuleType< TBaseModuleToFixedUpdate > ( )

Get the module matching the type from the _modulesToFixedUpdate list.

Template Parameters
TBaseModuleToFixedUpdate
Returns
Type Constraints
TBaseModuleToFixedUpdate :TBaseModule 

◆ GetModulesToLateUpdateByModuleType< TBaseModuleToLateUpdate >()

List< TBaseModuleToLateUpdate > NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.GetModulesToLateUpdateByModuleType< TBaseModuleToLateUpdate > ( )

Get the module matching the type from the _modulesToLateUpdate list.

Template Parameters
TBaseModuleToLateUpdate
Returns
Type Constraints
TBaseModuleToLateUpdate :TBaseModule 

◆ GetModulesToUpdateByModuleType< TBaseModuleToUpdate >()

List< TBaseModuleToUpdate > NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.GetModulesToUpdateByModuleType< TBaseModuleToUpdate > ( )

Get the module matching the type from the _modulesToUpdate list.

Template Parameters
TBaseModuleToUpdate
Returns
Type Constraints
TBaseModuleToUpdate :TBaseModule 

◆ InsertModuleToFixedUpdate()

void NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.InsertModuleToFixedUpdate ( TBaseModule moduleToFixedUpdate,
int index )

Inserts and replaced the module at the given index of the _modulesToFixedUpdate list.

Parameters
moduleToFixedUpdate
index

◆ InsertModuleToLateUpdate()

void NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.InsertModuleToLateUpdate ( TBaseModule moduleToLateUpdate,
int index )

Inserts and replaced the module at the given index of the _modulesToLateUpdate list.

Parameters
moduleToLateUpdate
index

◆ InsertModuleToUpdate()

void NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.InsertModuleToUpdate ( TBaseModule moduleToUpdate,
int index )

Inserts and replaced the module at the given index of the _modulesToUpdate list.

Parameters
moduleToUpdate
index

◆ RemoveModule()

void NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.RemoveModule ( TBaseModule module,
UpdateType updateType )

Remove the module from at least one of the lists (multiple possible set it up this way)

Parameters
module
updateType

◆ RemoveModuleFromFixedUpdate() [1/2]

void NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.RemoveModuleFromFixedUpdate ( int atIndex)

Remove the module from _modulesToFixedUpdate at index.

Parameters
atIndex

◆ RemoveModuleFromFixedUpdate() [2/2]

void NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.RemoveModuleFromFixedUpdate ( TBaseModule moduleToFixedUpdate)

Remove the module from _modulesToFixedUpdate.

Parameters
moduleToFixedUpdate

◆ RemoveModuleFromLateUpdate() [1/2]

void NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.RemoveModuleFromLateUpdate ( int atIndex)

Remove the module from _modulesToLateUpdate at index.

Parameters
atIndex

◆ RemoveModuleFromLateUpdate() [2/2]

void NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.RemoveModuleFromLateUpdate ( TBaseModule moduleToLateUpdate)

Remove the module from _modulesToLateUpdate.

Parameters
moduleToLateUpdate

◆ RemoveModuleFromUpdate() [1/2]

void NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.RemoveModuleFromUpdate ( int atIndex)

Remove the module from _modulesToUpdate at index.

Parameters
atIndex

◆ RemoveModuleFromUpdate() [2/2]

void NikosAssets.Modulize.BaseCompositeModule< TBaseModule >.RemoveModuleFromUpdate ( TBaseModule moduleToUpdate)

Remove the module from _modulesToUpdate.

Parameters
moduleToUpdate
The documentation for this class was generated from the following file:
  • BaseCompositeModule.cs