Interface IProvidesSlowTasks

Defines the API for slow task management

Inherited Members

IFunctionalityProvider.LoadProvider()

IFunctionalityProvider.ConnectSubscriber(object)

IFunctionalityProvider.UnloadProvider()

Namespace: Unity.MARS.MARSUtils

Assembly: Unity.MARS.Interfaces.dll

Syntax

[MovedFrom("Unity.MARS")]
public interface IProvidesSlowTasks : IFunctionalityProvider

Methods

AddMarsTimeSlowTask(Action, float, bool)

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
float	sleepTime	The amount of time to wait between executions
bool	replace	(Optional) Whether this should replace existing parameters for task if it has already been registered

Returns

Type	Description
bool	True if the task has not already been added or if replace is true, false otherwise

AddSlowTask(Action, float, bool)

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
float	sleepTime	The amount of time to wait between executions
bool	replace	(Optional) Whether this should replace existing parameters for task if it has already been registered

Returns

Type	Description
bool	True if the task has not already been added or if replace is true, false otherwise

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
bool	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
bool	True if the task was successfully found and removed, false otherwise