API:Class/ChangeHistoryService

Filtered-inheritance mode: While this class technically inherits all Instance class members, some (if not all) have been hidden because they serve no purpose for this object.
Plugin class: This object has been marked as a plugin class. Most if not all of its members are exclusive to the PluginSecurity level.
Service: This class is a service. It is a top-level singleton which can be obtained with the GetService method.
Uncreatable: This object cannot be created with Instance.new.

ExplorerImageIndex69.pngChangeHistoryService : Object Icon.pngInstance

The ChangeHistoryService provides a way for plugins to undo and redo changes and to create waypoints when changes are made to the place.

Functions

Functions [toggle]

bool, stringGetCanRedo ( ) [PluginSecurity]

Returns whether there are actions that can be redone, and, if there are, returns the last of them.

|RMD member="API:Class/ChangeHistoryService/GetCanRedo"|Returns whether there are actions that can be redone, and, if there are, returns the last of them.|/RMD|
bool, stringGetCanUndo ( ) [PluginSecurity]

Returns whether there are actions that can be undone, and, if there are, returns the last of them.

|RMD member="API:Class/ChangeHistoryService/GetCanUndo"|Returns whether there are actions that can be undone, and, if there are, returns the last of them.|/RMD|
voidRedo ( ) [PluginSecurity]

Executes the last action that was undone.

|RMD member="API:Class/ChangeHistoryService/Redo"|Executes the last action that was undone.|/RMD|
voidResetWaypoints ( ) [PluginSecurity]

Clears the history, causing all undo/redo waypoints to be removed.

|RMD member="API:Class/ChangeHistoryService/ResetWaypoints"|Clears the history, causing all undo/redo waypoints to be removed.|/RMD|
voidSetEnabled ( bool state ) [PluginSecurity]

Sets whether or not the ChangeHistoryService is enabled.

|RMD member="API:Class/ChangeHistoryService/SetEnabled"|Sets whether or not the ChangeHistoryService is enabled.|/RMD|
voidSetWaypoint ( string name ) [PluginSecurity]

Sets a new waypoint which can be used as an undo or redo point.

|RMD member="API:Class/ChangeHistoryService/SetWaypoint"|Sets a new waypoint which can be used as an undo or redo point.|/RMD|
voidUndo ( ) [PluginSecurity]

Undos the last action taken, for which there exists a waypoint.

|RMD member="API:Class/ChangeHistoryService/Undo"|Undos the last action taken, for which there exists a waypoint.|/RMD|
GetCanRedo ( ) [PluginSecurity]
Returns whether there are actions that can be redone, and, if there are, returns the last of them.
GetCanUndo ( ) [PluginSecurity]
Returns whether there are actions that can be undone, and, if there are, returns the last of them.
Redo ( ) [PluginSecurity]
Executes the last action that was undone.
ResetWaypoints ( ) [PluginSecurity]
Clears the history, causing all undo/redo waypoints to be removed.
SetEnabled ( bool state ) [PluginSecurity]
Sets whether or not the ChangeHistoryService is enabled.
SetWaypoint ( string name ) [PluginSecurity]
Sets a new waypoint which can be used as an undo or redo point.
Undo ( ) [PluginSecurity]
Undos the last action taken, for which there exists a waypoint.


Events

Events [toggle]

OnRedo ( string waypoint ) [PluginSecurity]

Fired when the user reverses the undo command. Waypoint describes the type action that has been redone.

|RMD member="API:Class/ChangeHistoryService/OnRedo"|Fired when the user reverses the undo command. Waypoint describes the type action that has been redone.|/RMD|
OnUndo ( string waypoint ) [PluginSecurity]

Fired when the user undoes an action in studio. Waypoint describes the type action that has been undone.

|RMD member="API:Class/ChangeHistoryService/OnUndo"|Fired when the user undoes an action in studio. Waypoint describes the type action that has been undone.|/RMD|
OnRedo ( string waypoint ) [PluginSecurity]
Fired when the user reverses the undo command. Waypoint describes the type action that has been redone.
OnUndo ( string waypoint ) [PluginSecurity]
Fired when the user undoes an action in studio. Waypoint describes the type action that has been undone.

|RMD member="API:Class/ChangeHistoryService"|The ChangeHistoryService provides a way for plugins to undo and redo changes and to create waypoints when changes are made to the place. |/RMD|