SetPlayerHeadSize: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetPlayerHeadSize(player, size)}} {{FuncParameters}} {{FuncParam|player|__EDIT_ME__}} {{FuncParam|..."
 
No edit summary
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Sets the player's head size.}}


{{FuncSyntax|SetPlayerHeadSize(player, size)}}
{{FuncSyntax|SetPlayerHeadSize(player, size)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|player|__EDIT_ME__}}
{{FuncParam|player|The player identifier}}
{{FuncParam|size|__EDIT_ME__}}
{{FuncParam|size|The size in floating point value (range 0.0 - 3.0)}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|This function returs 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__
{{ServerPlayerFunctions}}

Latest revision as of 14:51, 26 June 2021

SetPlayerHeadSize

Type: Function
Context: Server
Introduced: v1.0

Description

Sets the player's head size.

Syntax

SetPlayerHeadSize(player, size)

Parameters

  • player
    The player identifier
  • size
    The size in floating point value (range 0.0 - 3.0)

Return Value

  • This function returs 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=SetPlayerHeadSize&oldid=4860"