GetLocalPlayer: Difference between revisions
Jump to navigation
Jump to search
(Examples tested and improved) |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Client function}} | |||
__NOTOC__ | __NOTOC__ | ||
This function gets the player element of the client running the current script. | This function gets the player element of the client running the current script. | ||
| Line 4: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
player getLocalPlayer () | player getLocalPlayer ( ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 11: | Line 12: | ||
==Example== | ==Example== | ||
'''Example 1:''' This | '''Example 1:''' This client side function outputs the player's current location to the console. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
--we get the local player (we do this outside of the function body so it isn't retrieved every time the function is called, since the local player never changes) | -- we get the local player (we do this outside of the function body so it isn't retrieved every time | ||
local localPlayer = getLocalPlayer () | -- the function is called, since the local player never changes) | ||
local localPlayer = getLocalPlayer ( ) | |||
function outputLocalPlayerPosition () | function outputLocalPlayerPosition ( ) | ||
-- | -- get the local player's position | ||
local px, py, pz = getElementPosition ( localPlayer ) | local px, py, pz = getElementPosition ( localPlayer ) | ||
-- | -- output it to the console | ||
outputConsole ( "Your location: "..px.." "..py.." "..pz ) | outputConsole ( "Your location: " .. px .. " " .. py .. " " .. pz ) | ||
end | end | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Example 2:''' This | '''Example 2:''' This client side script makes the local player's camera flash red after being hit. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function flashRed () | function flashRed ( ) | ||
-- | -- fade out the local player's camera to red during a second | ||
fadeCamera( false, 1.0, 255, 0, 0 ) | fadeCamera( false, 1.0, 255, 0, 0 ) | ||
-- | -- set a 500 ms (0.5 sec) timer to fade it back in before it has completely faded out | ||
setTimer( fadeCamera, 500, 1, true, 1.0 ) | setTimer( fadeCamera, 500, 1, true, 1.0 ) | ||
end | end | ||
--we attach our 'flashRed' function to be a handler of "onClientPlayerDamage" when its source (that is, the hit player) is the local player | -- we attach our 'flashRed' function to be a handler of "onClientPlayerDamage" when its source (that is, the hit player) is the local player | ||
addEventHandler( "onClientPlayerDamage", getLocalPlayer(), flashRed ) | addEventHandler( "onClientPlayerDamage", getLocalPlayer ( ), flashRed ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Client_player_functions}} | {{Client_player_functions}} | ||
Revision as of 18:37, 19 August 2007
This function gets the player element of the client running the current script.
Syntax
player getLocalPlayer ( )
Returns
Returns the local player element.
Example
Example 1: This client side function outputs the player's current location to the console.
-- we get the local player (we do this outside of the function body so it isn't retrieved every time -- the function is called, since the local player never changes) local localPlayer = getLocalPlayer ( ) function outputLocalPlayerPosition ( ) -- get the local player's position local px, py, pz = getElementPosition ( localPlayer ) -- output it to the console outputConsole ( "Your location: " .. px .. " " .. py .. " " .. pz ) end
Example 2: This client side script makes the local player's camera flash red after being hit.
function flashRed ( ) -- fade out the local player's camera to red during a second fadeCamera( false, 1.0, 255, 0, 0 ) -- set a 500 ms (0.5 sec) timer to fade it back in before it has completely faded out setTimer( fadeCamera, 500, 1, true, 1.0 ) end -- we attach our 'flashRed' function to be a handler of "onClientPlayerDamage" when its source (that is, the hit player) is the local player addEventHandler( "onClientPlayerDamage", getLocalPlayer ( ), flashRed )
See Also
- getLocalPlayer
- getPlayerMapBoundingBox
- getPlayerMapOpacity
- isPlayerMapVisible
- resetBlurLevel
- isPlayerHudComponentVisible
- Shared
- getPlayerTeam
- getPlayerBlurLevel
- setPlayerBlurLevel
- getPlayerSerial
- forcePlayerMap
- getPlayerScriptDebugLevel
- getPlayerFromName
- getPlayerMoney
- getPlayerName
- getPlayerNametagColor
- getPlayerNametagText
- getPlayerPing
- getPlayerWantedLevel
- givePlayerMoney
- isPlayerMapForced
- isPlayerNametagShowing
- setPlayerHudComponentVisible
- setPlayerMoney
- setPlayerNametagColor
- setPlayerNametagShowing
- setPlayerNametagText
- takePlayerMoney
- countPlayersInTeam
- getPlayersInTeam
- isVoiceEnabled
- setControlState
- getControlState