GetPlayerHeadSize: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|GetPlayerHeadSize(player)}} {{FuncParameters}} {{FuncParam|player|__EDIT_ME__}} {{FuncReturnValue..."
 
28days (talk | contribs)
833 edits
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Get the player's head size set with [[SetPlayerHeadSize]].}}


{{FuncSyntax|GetPlayerHeadSize(player)}}
{{FuncSyntax|GetPlayerHeadSize(player)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|player|__EDIT_ME__}}
{{FuncParam|player|The player identifier.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|This function returns nothing.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua>
local ts12 = 0
function cmd_tscene12(player)
ts12 = CreateTimer(IncreaseHeadSize, 10, player)
end
AddCommand("tscene12", cmd_tscene12)
 
function IncreaseHeadSize(player)
local size = GetPlayerHeadSize(player) + 0.1
SetPlayerHeadSize(player, size)
if (size > 3.0) then
DestroyTimer(ts12)
end
end
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{Template:ServerPlayerFunctions}}

Latest revision as of 15:15, 21 January 2020

GetPlayerHeadSize

Type: Function
Context: Server
Introduced: v1.0

Description

Get the player's head size set with SetPlayerHeadSize.

Syntax

GetPlayerHeadSize(player)

Parameters

  • player
    The player identifier.

Return Value

  • This function returns nothing.

Example

local ts12 = 0
function cmd_tscene12(player)
	ts12 = CreateTimer(IncreaseHeadSize, 10, player)
end
AddCommand("tscene12", cmd_tscene12)

function IncreaseHeadSize(player)
	local size = GetPlayerHeadSize(player) + 0.1
	SetPlayerHeadSize(player, size)
	if (size > 3.0) then
		DestroyTimer(ts12)
	end
end

See also

Retrieved from "https://dev.playonset.com/index.php?title=GetPlayerHeadSize&oldid=3712"