Method::Resume

Defined in: C4Methods.h

Resumes a script method after a saved game is loaded.

Prototype

virtual void Resume(const ScriptState *state);

Parameters

state The current script state.

Description

The Resume function is called by the script controller after a saved game is loaded if the method was executing at the time that the game was saved. The override of this function should perform whatever actions are necessary to resume the execution of the method from the state that it was in when the method was previously saved.

It is only necessary to implement the Resume function for methods that take time to execute. If a method completes execution within the Method::Execute function, then it can never be in the executing state when a game is saved.