Squirrel/Client/Functions/Players/FindLocalPlayer

Latest revision as of 03:56, 24 September 2011

This function returns the player instance of the player running the client script.

[edit] Syntax

Player FindLocalPlayer( )

[edit] Example

 
function onClientCommand( cmd, text )
{
	if ( cmd == "whatsmyname" )
	{
		local plr = FindLocalPlayer();
		if(plr)
			Message( "Your name is " + plr.Name );
	}
}
 

This command will message a player their name when they use the client command /whatsmyname.

[edit] Notes

The call onClientCommand was used in in this example. More info about this in the corresponding page.

[edit] Related Functions

• FindLocalPlayer
• FindPlayer
• Player.Angle
• Player.Armour
• Player.Cash
• Player.Class
• Player.Colour
• Player.Frozen
• Player.Health
• Player.ID
• Player.Immune
• Player.Island
• Player.Marker
• Player.Name
• Player.Ping
• Player.Pos
• Player.RemoveLimb
• Player.Score
• Player.Skin
• Player.Spawn
• Player.Team
• Player.Train
• Player.Vehicle
• Player.Velocity
• Player.VirtualWorld
• Player.WantedLevel
• Player.Weapon
• Player.WeaponAmmo
• Player.WeaponState