Controller::InstanceExtractable
Defined in:
Returns a boolean value indicating whether the controller's target node should be extracted from an instanced world.
C4Controller.h
Prototype
virtual bool InstanceExtractable(bool subinstanceFlag) const;
Parameters
subinstanceFlag |
Indicates whether the target node is part of an instanced world nested within another instanced world. |
Description
The InstanceExtractable
function indicates whether a controller contains state that must be preserved when a world is saved and restored. By default, this function returns false
. If a subclass of the Controller
class overrides this function and returns true
, then it causes the nodes of any instanced world containing the controller to be extracted and placed in the enclosing world. This allows the controller's state to be saved and restored with the enclosing world instead of being reloaded from the original instanced world.
See Also