Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
user-grinch committed May 16, 2021
2 parents f2b4e3d + 9327fa5 commit 0470fa1
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 6 deletions.
1 change: 1 addition & 0 deletions api/pool-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Iterative lists containing handles to game types.
* building
* object
* ped
* script
* veh

**Example:**
Expand Down
30 changes: 24 additions & 6 deletions api/script-module.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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.

0 comments on commit 0470fa1

Please sign in to comment.