StateCollection.SaveHistory Property

StateCollectionSaveHistory Property

Gets or sets a value indicating whether this state collection has a "history state".

Namespace: DigitalRune.Game.States
Assembly: DigitalRune.Game (in DigitalRune.Game.dll) Version: 1.4.0.0 (1.4.0.14427)

Syntax

C++

Copy

public bool SaveHistory { get; set; }

Public Property SaveHistory As Boolean
	Get
	Set

public:
property bool SaveHistory {
	bool get ();
	void set (bool value);
}

member SaveHistory : bool with get, set

Property Value

Type: Boolean
if the collection saves its history; otherwise, . The default value is .

Remarks

When a state collection is re-entered, the initial state becomes active. But if this property is set to , the state collection remembers its history and on re-enter the last active state is reactivated. This functionality implements the "history state" of standard UML state machine.

Reference

StateCollection Class

DigitalRune.Game.States Namespace