GetLocalPlayer - Revision history

Srslyyyy at 16:19, 8 April 2024

2024-04-08T16:19:10Z

← Older revision		Revision as of 16:19, 8 April 2024
Line 18:		Line 18:
	'''Example 1:''' This client side 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">
	~~-- 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()		function outputLocalPlayerPosition()
	-- get the local player's position		-- get the local player's position

Srslyyyy at 16:18, 8 April 2024

2024-04-08T16:18:10Z

← Older revision		Revision as of 16:18, 8 April 2024
Line 38:		Line 38:
	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", localPlayer, flashRed)
	</syntaxhighlight>		</syntaxhighlight>

Srslyyyy at 16:17, 8 April 2024

2024-04-08T16:17:46Z

← Older revision		Revision as of 16:17, 8 April 2024
Line 4:		Line 4:

	{{New feature/item\|3.0110\|1.1\|\|		{{New feature/item\|3.0110\|1.1\|\|
	You ~~can~~ use ~~the~~ predefined variable '''localPlayer''' instead of typing getLocalPlayer()		You should use predefined variable '''localPlayer''' instead of typing getLocalPlayer() for better readability.
	}}		}}

Line 21:		Line 21:
	-- the function is called, since the local player never changes)		-- the function is called, since the local player never changes)

	function outputLocalPlayerPosition ( )		function outputLocalPlayerPosition()
	-- get the local player's position		-- get the local player's position
	local px, py, pz = getElementPosition ( ~~getLocalPlayer ( )~~ )		local px, py, pz = getElementPosition(localPlayer)
	-- output it to the console		-- output it to the console
	outputConsole ( "Your location: " .. px .. " " .. py .. " " .. pz )		outputConsole("Your location: "..px.." "..py .." "..pz)
	end		end
	</syntaxhighlight>		</syntaxhighlight>
Line 31:		Line 31:
	'''Example 2:''' This client side script makes the local player's camera flash red after being hit.		'''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		-- 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		-- 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>

MeowCola at 16:26, 18 September 2014

2014-09-18T16:26:47Z

← Older revision		Revision as of 16:26, 18 September 2014
Line 44:		Line 44:
	{{Client_player_functions}}		{{Client_player_functions}}

	[ru:getLocalPlayer]]		[[ru:getLocalPlayer]]

MeowCola at 16:07, 18 September 2014

2014-09-18T16:07:47Z

← Older revision		Revision as of 16:07, 18 September 2014
Line 3:		Line 3:
	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\|3.0110\|1.1\|		{{New feature/item\|3.0110\|1.1\|\|
	You can use the predefined variable '''localPlayer''' instead of typing getLocalPlayer()		You can use the predefined variable '''localPlayer''' instead of typing getLocalPlayer()
	}}		}}
Line 43:		Line 43:
	==See Also==		==See Also==
	{{Client_player_functions}}		{{Client_player_functions}}

			[ru:getLocalPlayer]]

Cro Capy: /* Example */

2013-05-07T15:51:56Z

Example

← Older revision		Revision as of 15:51, 7 May 2013
Line 23:		Line 23:
	function outputLocalPlayerPosition ( )		function outputLocalPlayerPosition ( )
	-- get the local player's position		-- get the local player's position
	local px, py, pz = getElementPosition ( ~~localPlayer~~ )		local px, py, pz = getElementPosition ( getLocalPlayer ( ) )
	-- output it to the console		-- output it to the console
	outputConsole ( "Your location: " .. px .. " " .. py .. " " .. pz )		outputConsole ( "Your location: " .. px .. " " .. py .. " " .. pz )

Cro Capy: /* Example */

2013-05-07T15:51:16Z

Example

← Older revision		Revision as of 15:51, 7 May 2013
Line 20:		Line 20:
	-- we get the local player (we do this outside of the function body so it isn't retrieved every time		-- 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)		-- the function is called, since the local player never changes)
	~~local localPlayer = getLocalPlayer ( )~~

	function outputLocalPlayerPosition ( )		function outputLocalPlayerPosition ( )

Arran Fortuna at 14:57, 25 April 2011

2011-04-25T14:57:14Z

← Older revision		Revision as of 14:57, 25 April 2011
Line 2:		Line 2:
	__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\|3.0110\|1.1\|
			You can use the predefined variable '''localPlayer''' instead of typing getLocalPlayer()
			}}

	==Syntax==		==Syntax==

Arc at 18:37, 19 August 2007

2007-08-19T18:37:49Z

← Older revision		Revision as of 18:37, 19 August 2007
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 ~~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">
	--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 ( )
	--we get the local player's position		-- get the local player's position
	local px, py, pz = getElementPosition ( localPlayer )		local px, py, pz = getElementPosition ( localPlayer )
	--we output it to the console		-- output it to the console
	outputConsole ( "Your location: "..px.." "..py.." "..pz )		outputConsole ( "Your location: " .. px .. " " .. py .. " " .. pz )
	end		end
	</syntaxhighlight>		</syntaxhighlight>

	'''Example 2:''' This ~~clientside~~ script makes the local player's camera flash red after being hit.		'''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 ( )
	--we fade out the local player's camera to red during a second		-- 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 500 ms (0.5 sec) timer to fade it back in before it has completely faded out		-- 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}}

Jbeta: Examples tested and improved

2007-08-02T12:13:07Z

Examples tested and improved

← Older revision		Revision as of 12:13, 2 August 2007
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