GetLocalPlayer: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Improved first example, added new one)
(Examples tested and improved)
Line 1: Line 1:
__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.  


==Syntax==  
==Syntax==  
Line 8: Line 8:


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


==Example==  
==Example==  
'''Example 1:''' This clientside function outputs the player's current location to the console.
'''Example 1:''' This clientside 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)
local localPlayer = getLocalPlayer ()
function outputLocalPlayerPosition ()
function outputLocalPlayerPosition ()
--we get the local player
local localPlayer = getLocalPlayer ()
--we get the local player's position
--we get the local player's position
local px, py, pz = getElementPosition ( localPlayer )
local px, py, pz = getElementPosition ( localPlayer )
Line 26: Line 27:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function flashRed ()
function flashRed ()
--we fade the local player's camera red during a second
--we 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 )
--we set a 1000 ms (1 sec) timer to fade it back out
--we set a 500 ms (0.5 sec) timer to fade it back in before it has completely faded out
setTimer( fadeCamera, 1000, 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

Revision as of 12:13, 2 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 clientside 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 ()
	--we get the local player's position
	local px, py, pz = getElementPosition ( localPlayer )
	--we output it to the console
	outputConsole ( "Your location: "..px.." "..py.." "..pz )
end

Example 2: This clientside script makes the local player's camera flash red after being hit.

function flashRed ()
	--we fade out the local player's camera to red during a second
	fadeCamera( false, 1.0, 255, 0, 0 )
	--we 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