Scripting:TWBaseScript: Difference between revisions

Building pieces of another world.
Jump to navigation Jump to search
gravatar The Watcher [userbureaucratsysopPHRhYmxlIGNsYXNzPSJ0d3BvcHVwIj48dHI+PHRkIGNsYXNzPSJ0d3BvcHVwLWVudHJ5dGl0bGUiPkdyb3Vwczo8L3RkPjx0ZD51c2VyPGJyIC8+YnVyZWF1Y3JhdDxiciAvPnN5c29wPGJyIC8+PC90ZD48L3RyPjwvdGFibGU+] (talk | contribs)
(Created page with "All scripts provided by TWScript are derived from this base script. This base script provides one directive that the FM maker may include in the <code>Editor -> Design Note</c...")
 
gravatar The Watcher [userbureaucratsysopPHRhYmxlIGNsYXNzPSJ0d3BvcHVwIj48dHI+PHRkIGNsYXNzPSJ0d3BvcHVwLWVudHJ5dGl0bGUiPkdyb3Vwczo8L3RkPjx0ZD51c2VyPGJyIC8+YnVyZWF1Y3JhdDxiciAvPnN5c29wPGJyIC8+PC90ZD48L3RyPjwvdGFibGU+] (talk | contribs)
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
All scripts provided by TWScript are derived from this base script. This base script provides one directive that the FM maker may include in the <code>Editor -> Design Note</code> for any object that uses a TWScript script:
All scripts provided by TWScript are derived from this base script. This base script provides one directive that the FM maker may include in the <code>Editor -> Design Note</code> for any object that uses a TWScript script. <code>[ScriptName]</code> here is the name of the script as you entered it into the <code>S->Scripts</code> property:


; <code>[ScriptName]Debug</code>
; <code><nowiki>[ScriptName]Debug</nowiki></code>
: Type: [[https://thief.starforge.co.uk/wiki/Scripting:Design_Note#bool|boolean]]
: '''Type''': [[Scripting:Design_Note#bool|boolean]]
: All scripts derived from TWBaseScript can have debugging output enabled by setting this parameter to a true value. Output goes to the DromEd Monolog window, and the information printed depends on the script being debugged. This defaults to <code>false</code>, and while you can leave debugging enabled when releasing your level, you may get small performance improvements by ensuring that debugging is turned off before release.
: All scripts derived from TWBaseScript can have debugging output enabled by setting this parameter to a true value. Output goes to the DromEd Monolog window, and the information printed depends on the script being debugged. This defaults to <code>false</code>, and while you can leave debugging enabled when releasing your level, you may get small performance improvements by ensuring that debugging is turned off before release.
: Example: <code>TWTrapSetSpeedDebug=true</code>
: '''Example''': <code>TWTrapSetSpeedDebug=true</code>


{{Scripting:Navbox}}
{{Scripting:Navbox}}
{{:Site Navigation}}
{{:Site Navigation}}
<references />
<references />

Latest revision as of 22:42, 20 June 2020

All scripts provided by TWScript are derived from this base script. This base script provides one directive that the FM maker may include in the Editor -> Design Note for any object that uses a TWScript script. [ScriptName] here is the name of the script as you entered it into the S->Scripts property:

[ScriptName]Debug
Type: boolean
All scripts derived from TWBaseScript can have debugging output enabled by setting this parameter to a true value. Output goes to the DromEd Monolog window, and the information printed depends on the script being debugged. This defaults to false, and while you can leave debugging enabled when releasing your level, you may get small performance improvements by ensuring that debugging is turned off before release.
Example: TWTrapSetSpeedDebug=true


Authors

  • gravatar The Watcher [userbureaucratsysopPHRhYmxlIGNsYXNzPSJ0d3BvcHVwIj48dHI+PHRkIGNsYXNzPSJ0d3BvcHVwLWVudHJ5dGl0bGUiPkdyb3Vwczo8L3RkPjx0ZD51c2VyPGJyIC8+YnVyZWF1Y3JhdDxiciAvPnN5c29wPGJyIC8+PC90ZD48L3RyPjwvdGFibGU+]