Scripting/Squirrel/Functions/FindPlayer: 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
No edit summary
No edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Scripting/Needs_Text}}
Retrieve a player object from player's name or ID.


== Syntax ==
== Syntax ==


<pre>FindPlayer( text )</pre>
<pre>FindPlayer( identity )</pre>
 
== Arguments ==
 
* ''string/integer'' '''identity''' - The player's name or ID.


== Example ==
== Example ==
Line 20: Line 24:
=== Notes ===
=== Notes ===
Call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.
Call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.
{{Scripting/Needs_Example}}
 
== Related Functions ==
 
{{Scripting/Squirrel/Functions/Player_Functions}}
[[Category:Scripting/Squirrel/Functions/Player_Functions]]

Latest revision as of 18:45, 30 January 2017

Retrieve a player object from player's name or ID.

Syntax

FindPlayer( identity )

Arguments

  • string/integer identity - The player's name or ID.

Example

     if ( cmd == "goto" )
    {
          local plr = FindPlayer( text );
          
          if ( !plr ) MessagePlayer( "[#ffffff]Player" + text + "' no server .", player );
          else player.Pos = plr.Pos;
          MessagePlayer( "[#ffffff] Teleport to [" + plr.Name + "].", player );
         MessagePlayer( "[#ffffff] Player " + player.Name + " teleport to you.", plr );
    }

Notes

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

Related Functions

Player Game Functions

These functions exist for compatibility with the R2 Squirrel server.