GetPlayerSkin: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
m (Changed "DeprecatedWithAlt" template to "Deprecated")
 
(13 intermediate revisions by 9 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
==Description==
{{Server client function}}
This function returns an integer containing the ID number of the selected player's skin.
{{Deprecated|getElementModel|}}
 
This function returns an integer containing the ID number of the specified player's skin.


==Syntax==
==Syntax==
int [[getPlayerSkin]] ( [[player]] player )
<syntaxhighlight lang="lua">int getPlayerSkin ( player thePlayer )</syntaxhighlight>


===Required Arguments===
===Required Arguments===
*'''player''': The [[player]] whose skin you want to retrieve.
*'''player''': The player whose skin ID you want to retrieve.
 
===Returns===
Returns an [[int]] indicating which skin the player has. See [[Character Skins]].


==Example==
==Example==
if ([[spawnPlayer]] ( player, 1000, 1000, 1000, 90, 650 ) )
<section name="Server" class="server " show="true">
  [[serverChat]] ( "Player's skin ID is: ", [[getPlayerSkin]] (player) )
'''Example 1:''' This example spawns a player and tells him his skin
<syntaxhighlight lang="lua">
-- Spawn a player
if ( spawnPlayer ( myPlayer, 1000, 1000, 1000, 90, 650 ) ) then
-- Tell the player what skin they've spawned with
outputChatBox ( "Your skin ID is: " .. getPlayerSkin ( myPlayer ), myPlayer )
end
</syntaxhighlight>
'''Example 2:''' This example adds a "skin" command in console, which tells the player his/her skin.
<syntaxhighlight lang="lua">
function checkSkin ( source, commandName )
outputChatBox ( "Your skin ID is: " .. getPlayerSkin ( source ), source )
end
addCommandHandler ( "skin", checkSkin )
</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
This example adds a "skin" command in console, which tells the player his/her skin.
<syntaxhighlight lang="lua">
function checkSkin ( commandName )
outputChatBox ( "Your skin ID is: " .. getPlayerSkin ( getLocalPlayer() ) )
end
end
addCommandHandler ( "skin", checkSkin )
</syntaxhighlight>
</section>
==See Also==
{{Player functions}}

Latest revision as of 16:18, 13 February 2015

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.

Please use getElementModel instead.


This function returns an integer containing the ID number of the specified player's skin.

Syntax

int getPlayerSkin ( player thePlayer )

Required Arguments

  • player: The player whose skin ID you want to retrieve.

Returns

Returns an int indicating which skin the player has. See Character Skins.

Example

Click to collapse [-]
Server

Example 1: This example spawns a player and tells him his skin

-- Spawn a player 
if ( spawnPlayer ( myPlayer, 1000, 1000, 1000, 90, 650 ) ) then
	-- Tell the player what skin they've spawned with
	outputChatBox ( "Your skin ID is: " .. getPlayerSkin ( myPlayer ), myPlayer )
end

Example 2: This example adds a "skin" command in console, which tells the player his/her skin.

function checkSkin ( source, commandName )
	outputChatBox ( "Your skin ID is: " .. getPlayerSkin ( source ), source )
end
addCommandHandler ( "skin", checkSkin )
Click to collapse [-]
Client

This example adds a "skin" command in console, which tells the player his/her skin.

function checkSkin ( commandName )
	outputChatBox ( "Your skin ID is: " .. getPlayerSkin ( getLocalPlayer() ) )
end
addCommandHandler ( "skin", checkSkin )

See Also