From 9327fa523831e9076e51c193a207806185beb140 Mon Sep 17 00:00:00 2001 From: Grinch_ Date: Sun, 16 May 2021 09:20:10 +0000 Subject: [PATCH] GitBook: [master] 23 pages modified --- api/pool-module.md | 1 + api/script-module.md | 30 ++++++++++++++++++++++++------ 2 files changed, 25 insertions(+), 6 deletions(-) diff --git a/api/pool-module.md b/api/pool-module.md index cbb02e9..e85bf80 100644 --- a/api/pool-module.md +++ b/api/pool-module.md @@ -5,6 +5,7 @@ Iterative lists containing handles to game types. * building * object * ped +* script * veh **Example:** diff --git a/api/script-module.md b/api/script-module.md index 9b7d496..9858ca4 100644 --- a/api/script-module.md +++ b/api/script-module.md @@ -1,21 +1,35 @@ # Script -### get\_author\(\) +### get\_author\( **script\_file\_name** : str \) Returns the name of the script author. Returns an empty string if the author is not provided. -### get\_desc\(\) +**script\_file\_name \( with extension \):** Optional, passing no arguments would return the value of the current script. + +### get\_desc\( **script\_file\_name** : str \) Returns the description of the script. Returns an empty string if the description is not provided. -### get\_name\(\) +**script\_file\_name \( with extension \):** Optional, passing no arguments would return the value of the current script. + +### get\_file\_name\( **script\_file\_name** : str \) + +Returns the file\_name of the script \( with extension \). + +**script\_file\_name \( with extension \):** Optional, passing no arguments would return the value of the current script. + +### get\_name\( **script\_file\_name** : str \) Returns the name of the script. Returns an empty string if the name is not provided. -### get\_version\(\) +**script\_file\_name \( with extension \):** Optional, passing no arguments would return the value of the current script. + +### get\_version\( **script\_file\_name** : str \) Returns the version string of the script. An empty script is returned if none provided. +**script\_file\_name \( with extension \):** Optional, passing no arguments would return the value of the current script. + ### author\(name :str\) Sets the name of the script author. @@ -32,11 +46,15 @@ Sets the script name. Sets the script version. -### load\(file\_name :str\) +### load\(script\_file\_name :str\) Loads a script from the provided filename. -### unload\(file\_name :str\) - Experimental +**script\_file\_name \( with extension \):** Optional, passing no arguments would return the value of the current script. + +### unload\(script\_file\_name :str\) Unloads a script from the provided filename. +**script\_file\_name \( with extension \):** Optional, passing no arguments would return the value of the current script. +