Scripting/Squirrel/Functions/Player.State: 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 "== Syntax == <pre>player.State</pre>")
 
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Syntax ==
== Syntax ==


<pre>player.State</pre>
<pre>player.State (The player's current state as an integer)</pre>
 
== Example ==
 
<pre>
function onPlayerCommand( player, cmd, text )
{
    if(cmd == "state")
    {
        ClientMessage("Your current State: "+player.State+" (state as integer)",player,255,255,255);
    }
}
</pre>
 
=== Notes ===
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.
 
== Player State list ==
<div>
{| class="wikitable"
!State ID
!Description
|-
|0
|Player State None
|-
|1
|Player State OnFoot
|-
|2
|Player State Aim
|-
|3
|Player State Driver
|-
|4
|Player State Passenger
|-
|5
|Player State Enter Vehicle
|-
|6
|Player State Enter Passenger
|-
|7
|Player State Exit Vehicle
|-
|8
|Player State Not Spawned
|}
</div>
 
== Related Functions ==
 
{{Scripting/Squirrel/Functions/Player Functions}}
[[Category:Scripting/Squirrel/Functions/Player_Functions]]

Latest revision as of 18:57, 30 January 2017

Syntax

player.State (The player's current state as an integer)

Example

function onPlayerCommand( player, cmd, text )
{
    if(cmd == "state")
    {
        ClientMessage("Your current State: "+player.State+" (state as integer)",player,255,255,255);
    }
}

Notes

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

Player State list

State ID Description
0 Player State None
1 Player State OnFoot
2 Player State Aim
3 Player State Driver
4 Player State Passenger
5 Player State Enter Vehicle
6 Player State Enter Passenger
7 Player State Exit Vehicle
8 Player State Not Spawned

Related Functions

Player Game Functions

These functions exist for compatibility with the R2 Squirrel server.

Retrieved from "http://wiki.vc-mp.org/index.php?title=Scripting/Squirrel/Functions/Player.State&oldid=19736"