Interface IProvidesSlowTasks
Defines the API for slow task management
Inherited Members
Namespace: Unity.MARS.MARSUtils
Syntax
[MovedFrom("Unity.MARS")]
public interface IProvidesSlowTasks : IFunctionalityProviderMethods
AddMarsTimeSlowTask(Action, Single, Boolean)
Registers the given task and starts it running at regular intervals based on MARS time
Declaration
bool AddMarsTimeSlowTask(Action task, float sleepTime, bool replace = false)Parameters
| Type | Name | Description |
|---|---|---|
| Action | task | The delegate to execute at each interval |
| Single | sleepTime | The amount of time to wait between executions |
| Boolean | replace | (Optional) Whether this should replace existing parameters
for |
Returns
| Type | Description |
|---|---|
| Boolean | True if the task has not already been added or if |
AddSlowTask(Action, Single, Boolean)
Registers the given task and starts it running at regular intervals based on game time
Declaration
bool AddSlowTask(Action task, float sleepTime, bool replace = false)Parameters
| Type | Name | Description |
|---|---|---|
| Action | task | The delegate to execute at each interval |
| Single | sleepTime | The amount of time to wait between executions |
| Boolean | replace | (Optional) Whether this should replace existing parameters
for |
Returns
| Type | Description |
|---|---|
| Boolean | True if the task has not already been added or if |
RemoveMarsTimeSlowTask(Action)
Unregisters the given MARS-time task and stops running it
Declaration
bool RemoveMarsTimeSlowTask(Action task)Parameters
| Type | Name | Description |
|---|---|---|
| Action | task | The task to remove |
Returns
| Type | Description |
|---|---|
| Boolean | True if the task was successfully found and removed, false otherwise |
RemoveSlowTask(Action)
Unregisters the given task and stops running it
Declaration
bool RemoveSlowTask(Action task)Parameters
| Type | Name | Description |
|---|---|---|
| Action | task | The task to remove |
Returns
| Type | Description |
|---|---|
| Boolean | True if the task was successfully found and removed, false otherwise |