What problem(s) does this solve?
- Known pattern for extension of the system (a System node)
- Common game specific functionality is easily implemented by overriding the appropriate method
$CHARACTERSYSTEM is a client-only system node
The $CHARACTERSYSTEM system node exists only on the client at this time as it handles client-side callbacks.
Adding game-specific functionality
As a required class/script, it is not permissible to make changes to the _characterSystemClassMethods script. Instead, extension/overriding the script is accomplished by the creation of a game-specific class (and class methods script) that is GLOMmed onto the CHARACTERSYSTEM prototype.
- Create a new class
- Create a class method script for the class
- GLOM the class onto the prototype
Create a game-specific class
Using the DOM Editor create a new (server|client) class. Our recommendation is that you use a class name that incorporates the _characterSystem as a suffix to the name (ex. HJ_characterSystem), this makes it easier to locate the pair of classes (the required script prefixed in _characterSystem and your game-specific class).
Once you have created the game-specific class, create a new client class methods script for that class.
Adding a game-specific class
Adding your game-specific class to the CHARACTERSYSTEM prototype is achieved using the System Node Configuration GUI or the CLI server command \mpac or client |mpac in the Console Panel. The System Node Configuration GUI is the preferred method because it handles the communication to update any instantiations of a system node to reflect the changes you have made.
Using the System Node Configuration GUI
Opening the System Node Configuration GUI requires you to access the hidden Utilities Interface toolbox, located in the top left corner of the render window with
ctrl-shift-click (or press
F5), which will open the Interface. On the Tools tab within the menu, is an option to open the System Nodes Configuration GUI.
See also: Adapting Clean Engine
Using the CLI
It is important to recognize that modification of the prototype from which a system node is instantiated will not update any instantiations that have already been made in various local GOMs. That means your changes will not take effect until the area (in the case of server system nodes) restarts, or the client (in the case of client system nodes), restarts.
\mpac CHARACTERSYSTEM, hj_characterSystem;
|mpac CHARACTERSYSTEM, hj_characterSystem;
- System Nodes - Primary mechanism for enabling the extension/overriding of the required Clean Engine implementations and a game-specific implementation of a licensee.