Scripting/Squirrel/Functions/GetFastSwitch: Difference between revisions

From Vice City Multiplayer
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing
(Created page with "This function will return the current status of the fast switch ability. == Syntax == <pre>EnabledFastSwitch()</pre> == Arguments == '''N/A''' == Return value == * ''boo...")
 
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
== Syntax ==
== Syntax ==


<pre>EnabledFastSwitch()</pre>
<pre>GetFastSwitch()</pre>


== Arguments ==
== Arguments ==
Line 14: Line 14:


== Example ==
== Example ==
This command will check whether the FastSwitch is on or off
<source lang=squirrel>
function onPlayerCommand(player,cmd,text)
{
if(cmd=="gfs")
{
MessagePlayer("FastSwitch Status: "+GetFastSwitch(),player);
}
}


{{Scripting/Needs_Example}}
</source>
 
=== Notes ===
=== Notes ===


Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.


== Related Functions ==
== Related Functions ==


{{Scripting/Squirrel/Functions/Server_Settings}}
{{Scripting/Squirrel/Functions/Server Settings}}
[[Category:Scripting/Squirrel/Functions/Server_Settings _Functions]]

Latest revision as of 19:08, 30 January 2017

This function will return the current status of the fast switch ability.

Syntax

GetFastSwitch()

Arguments

N/A

Return value

  • bool toggled - true or false

Example

This command will check whether the FastSwitch is on or off

function onPlayerCommand(player,cmd,text)
{
if(cmd=="gfs")
{
MessagePlayer("FastSwitch Status: "+GetFastSwitch(),player);
}
}

Notes

Call onPlayerCommand were used in this example. More info about them in the corresponding pages.

Related Functions