gta.terminateScript: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
{{ | {{ScriptItem2 | ||
| | |name = gta.terminateScript | ||
|side = client | |||
|type = function | |type = function | ||
| | |games = iii vc sa iv | ||
|desc = end a game script, specified by script name (immediately stops the script) | |||
|arg1 = string scriptName The name of the script to terminate. | |||
|return = void void | |||
| | |freturn = void | ||
| | |note = This does NOT apply to resources! This only stops SCM game scripts (use [[gta.getActiveScripts|gta.getActiveScripts]] to see currently running scripts. | ||
| | |||
| | |||
}} | }} |
Latest revision as of 20:36, 19 November 2022
Function
Client Only
Online and Offline
Available since Client 1.0.0
void gta.terminateScript(string scriptName)
The gta.terminateScript function is used to end a game script, specified by script name (immediately stops the script).
Parameters
1) | string | scriptName | The name of the script to terminate. |
Return
void | This function doesn't return a value. |
Notes
- This does NOT apply to resources! This only stops SCM game scripts (use gta.getActiveScripts to see currently running scripts.
Examples
There aren't any examples for this function.
Compatibility
There isn't any compatibility information for this function.
Related
Client Related
gta.getActiveScripts
gta.scriptCommand
gta.startNewScript
gta.terminateScript