__init__ def __init__(self, doneEvent) Undocumented function. |
enter def enter(self) Enters the StateData. This makes it active in whatever sense this applies. Returns true if this is a change (i.e. it was not previously entered), or false if this is the same (i.e. it was already entered). |
exit def exit(self) Exits the StateData. Returns true if this is a change (i.e. it was previously entered), or false if this is the same (i.e. it was already exited). |
getDoneStatus def getDoneStatus(self) The done status of a state data may be anything. It is common practice to return a Python dictionary or a string; the default value is None. |
load def load(self) Loads the StateData. This loads whatever assets are needed from disk, and otherwise prepares the StateData for being entered, without actually entering it. Returns true if this is a change (i.e. it was not already loaded), or false if this is the same (i.e. it was previously loaded). |
unload def unload(self) Unloads the StateData. This frees whatever assets were loaded by load(), and generally makes the memory usage for this thing be as small as possible. Some StateData-derived classes can load and unload repeatedly; others are useless once they have been unloaded. |