This Plugin makes it a lot easier to add your own text controls, but here are some things to take on board while you do
Don't try this unless you know a little bit of scripting!
1) Pick a control name
Make sure you pick a control name that is not already occupied
Ones that start with
b, c, e, f, g, l, n, r, v, or w
should never really be used
Make sure you pick a control name that does not start with another control name that runs after that other name!
- eg. two control names: swd and swdfm
- If you insist on having them both, ensure swdfm is run first
For good practise, ensure it starts with a letter and is about 2-4 characters long
2) Add in the control handler
- Ensure it is placed in an area that overrides this plugin
- The best way to do that is to set this Plugin as a requirement for wherever you add the handler
- Here is an example below
Code:
Modular_Messages::Controls.add("swdfm", {
"both" => true,
"before_appears" => proc { |hash, param|
param = _INTL("epic") if param == ""
hash["text"] = _INTL("Swdfm is {1}!: ", param) + hash["text"]
}
})
- Near the end of the first line goes your control name
3) The hash keys are as follows:
"solo" => TRUE_OR_FALSE
- Ensures the command is read only as \CONTROL_NAME and not \CONTROL_NAME[PARAM]
"both" => TRUE_OR_FALSE
- Ensures the command is read both as \CONTROL_NAME and \CONTROL_NAME[PARAM]
- If no [PARAM] is given, the PARAM is read as ""
Adding neither "solo" nor "both" means the script reads the control only as \CONTROL_NAME[PARAM]
"on_text_chunks" => PROC
- Runs just after the text has been separated into text chunks and controls
- hash["text_chunks"] refers to the chunks
- hash["index"] refers to which text chunk is being iterated through
- Goes 0, 1, 2...
"before_appears" => PROC
- Runs before the box itself appears
- Useful to make any changes to the whole text/window
"during_loop"
- Runs upon the messagebox getting to that control
- Used for making changes midway through the text running
