GetPlayerFromNick
From Multi Theft Auto: Wiki
This function is deprecated. This means that its use is discouraged and that it might not exist in future versions. | |
Please use getPlayerFromName instead. |
This function returns a player element for the player with the name passed to the function.
Syntax
player getPlayerFromNick ( string playerName )
Required Arguments
- playerName: A string containing the name of the player you want to reference
Returns
Returns a player element for the player with the nickname provided. If there is no player with that name, false is returned.
Example
This example finds a player as specified in the command and outputs the direction and distance he is from the player who entered the command. For example: 'locate someguy'.
function locatePlayer( sourcePlayer, command, who ) local targetPlayer = getPlayerFromNick ( who ) -- find the player that was specified in the command if ( targetPlayer ) then -- if a player was found local x,y,z = getElementPosition ( sourcePlayer ) -- save the position of the player who entered the command local xp,yp,zp = getElementPosition ( targetPlayer ) -- save the position of the player who should be located local dir = nil if (yp > y) then dir = "N" else dir = "S" end if (xp > x) then dir = dir .. "E" else dir = dir .. "W" end local distance = math.ceil ( getDistanceBetweenPoints3D(x, y, z, xp, yp, zp) ) outputChatBox( who .. " found " .. dir .. " (" .. distance .. ")", sourcePlayer) -- output the message end end addCommandHandler ( "locate", locatePlayer )
See Also
- forcePlayerMap
- getAlivePlayers
- getDeadPlayers
- getPlayerACInfo
- getPlayerAnnounceValue
- getPlayerBlurLevel
- getPlayerCount
- getPlayerFromName
- getPlayerIdleTime
- getPlayerIP
- getPlayerMoney
- getPlayerName
- getPlayerNametagColor
- getPlayerNametagText
- getPlayerPing
FROM VERSION 1.5.7 r19626 ONWARDS
- getPlayerSerial
- getPlayerTeam
- getPlayerVersion
- getPlayerWantedLevel
- getRandomPlayer
- givePlayerMoney
- isPlayerMapForced
- isPlayerMuted
- isPlayerNametagShowing
- isVoiceEnabled
- redirectPlayer
- resendPlayerACInfo
- resendPlayerModInfo
- setPlayerAnnounceValue
- setPlayerBlurLevel
- setPlayerHudComponentVisible
- setPlayerMoney
- setPlayerMuted
- setPlayerName
- setPlayerNametagColor
- setPlayerNametagShowing
- setPlayerNametagText
FROM VERSION 1.5.7 r19626 ONWARDS
- setPlayerTeam
- setPlayerVoiceBroadcastTo
- setPlayerVoiceIgnoreFrom
- setPlayerWantedLevel
- spawnPlayer
- takePlayerMoney
- takePlayerScreenShot