GetLocalPlayer: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
mNo edit summary
(7 intermediate revisions by 5 users not shown)
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.  
 
{{New feature/item|3.0110|1.1||
You can use the predefined variable '''localPlayer''' instead of typing getLocalPlayer()
}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
player getLocalPlayer ()
player getLocalPlayer ( )
</syntaxhighlight>
</syntaxhighlight>


===Returns===
===Returns===
Returns a [[player]] element.
Returns the local [[player]] element.


==Example==  
==Example==  
This clientside function outputs the player's current location to the console.
'''Example 1:''' This client side function outputs the player's current location to the console.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function outputPOS ()
-- we get the local player (we do this outside of the function body so it isn't retrieved every time
--we get the player element
-- the function is called, since the local player never changes)
local player = getLocalPlayer ()
 
--we get the player's position
function outputLocalPlayerPosition ( )
local px, py, pz = getPlayerPosition ( player )
-- get the local player's position
--we output it to the console
local px, py, pz = getElementPosition ( getLocalPlayer ( ) )
outputConsole ( "Your location: "..px.." "..py.." "..pz )
-- output it to the console
end
outputConsole ( "Your location: " .. px .. " " .. py .. " " .. pz )
end
end
</syntaxhighlight>
'''Example 2:''' This client side script makes the local player's camera flash red after being hit.
<syntaxhighlight lang="lua">
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 )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Client_player_functions}}
{{Client_player_functions}}
[[ru:getLocalPlayer]]

Revision as of 16:26, 18 September 2014

This function gets the player element of the client running the current script.

You can use the predefined variable localPlayer instead of typing getLocalPlayer()

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)

function outputLocalPlayerPosition ( )
	-- get the local player's position
	local px, py, pz = getElementPosition ( getLocalPlayer ( ) )
	-- 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

Retrieved from "https://wiki.multitheftauto.com/wiki/GetLocalPlayer?oldid=42054"