diff options
Diffstat (limited to 'sigmod/GlobalScript.h')
| -rw-r--r-- | sigmod/GlobalScript.h | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/sigmod/GlobalScript.h b/sigmod/GlobalScript.h index 9d538968..1c31670d 100644 --- a/sigmod/GlobalScript.h +++ b/sigmod/GlobalScript.h @@ -107,10 +107,14 @@ class SIGMOD_EXPORT GlobalScript : public Object * Sets the script that contains common code that is available for use by other scripts. The following * objects are available to the script (\p NULL if unavailable): * - * - \b client -- The \link Sigencore::Client client \endlink which owns \b owner. + * - \b script -- The \link Sigscript::GlobalScriptWrapper wrapper \endlink for the script. + * - \b player -- The \link Sigencore::Player player \endlink the script is active. * - \b sigmod -- The \link Sigscript::SigmodWrapper wrapper \endlink for the \link Sigmod sigmod \endlink in use. - * - \b arena -- The \link Sigencore::Arena arena \endlink the ability is being used in. - * - \b world -- The \link Sigworld::Map map \endlink for the \link Map map \endlink the player is on. + * - \b arena -- The \link Sigencore::Arena arena \endlink that is active. + * - \b world -- The \link Sigworld::Map map \endlink for the \link Sigscript::MapWrapper map \endlink that is active. + * + * Other objects may be available to the script depending on its context. Also, objects may be added to the script by + * giving the script more before it is started. * * \param script The script. */ |