diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/user-defined-variables.json b/Projects/Superalgos/Schemas/Docs-Nodes/user-defined-variables.json new file mode 100644 index 000000000..299e82b2f --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Nodes/user-defined-variables.json @@ -0,0 +1,29 @@ +{ + "type": "User Defined Variables", + "definition": { + "text": "The User Defined Variables node structure is an unused area of the Trading Engine users can access from within their Trading System to store data.", + "updated": 1622234154032 + }, + "paragraphs": [ + { + "style": "Text", + "text": "

Overview

Oftentimes, when building a strategy, the need for a place to store some data may arise. The User Defined Variables nodes are is the correct place to do this. The children nodes, (User Defined variable nodes), of this node are unused by the base code of the Superalgos processes thus the data placed inside these variables will remain unchanged and available for the duration of the episode.", + "updated": 1622249947455 + }, + { + "style": "Text", + "text": "

Additional Info

", + "updated": 1622250099965 + }, + { + "style": "Text", + "text": "- Persistence: It should be noted that these variables will persist throughout the engine's episode; not just at the stage or strategy layer from which they are set.", + "updated": 1622250113448 + }, + { + "style": "Text", + "text": "- State: A user defined variable is mutable.", + "updated": 1622250209793 + } + ] +} \ No newline at end of file