 | TimedStateTrackerTStateData Class |
The same as StateTracker, but states can also time out.
Inheritance HierarchyNamespace: Gamelogic.Extensions
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
SyntaxC#
public class TimedStateTracker<TStateData>
Type Parameters
- TStateData
- The type of the t state data.
The TimedStateTrackerTStateData type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TimedStateTrackerTStateData |
Initializes a new instance of the TimedStateTrackerTStateData class.
|
Properties| Name | Description | |
|---|---|---|
 | ActiveTokens |
Returns all the active tokens: tokens returned when states has been started that has not yet
been stopped.
|
| IsActive |
Gets a value indicating whether this tracker is active, that is, whether
any state has been started that has not been stopped.
|
| IsPaused |
Gets a value indicating whether this tracker is paused.
|
Methods| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| Pause |
Pauses this tracker.
|
| StartState(TStateData, Single) |
Starts a state, and returns a token that can be used to stop it again.
|
| StartState(TStateData, Single, Action) |
Starts a state, and returns a token that can be used to stop it again.
|
| StopState |
Stops the state associated with the token. The token must be one that was
returned when the state was started.
|
| ToString | (Inherited from Object.) |
| Unpause |
Unpauses this tracker.
|
| Update |
Updates this tracker with the specified current time.
|
Events| Name | Description | |
|---|---|---|
 | OnStateActive |
Occurs when this tracker is inactive and a state is started (so that this tracker becomes active).
|
| OnStateInactive |
Occurs when all active states are stopped, that is, when this tracker is active and becomes inactive.
|
Extension Methods| Name | Description | |
|---|---|---|
 | ThrowIfNull |
Throws a NullReferenceException if the object is null.
(Defined by ObjectExtensions.) |
RemarksTime-outs are managed by this class: when the state times out,
it is stopped, and an event is raised. This tracker must be updated (typically
in a mono-behaviour Update method).
See Also