SetPickupScale: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetPickupScale(pickup, sx, sy, sz)}} {{FuncParameters}} {{FuncParam|pickup|__EDIT_ME__}} {{FuncPar...")
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Set's the size scaling of the pickup.}}


{{FuncSyntax|SetPickupScale(pickup, sx, sy, sz)}}
{{FuncSyntax|SetPickupScale(pickup, sx, sy, sz)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|pickup|__EDIT_ME__}}
{{FuncParam|pickup|The pickup identifier.}}
{{FuncParam|sx|__EDIT_ME__}}
{{FuncParam|sx|The scale X axis}}
{{FuncParam|sy|__EDIT_ME__}}
{{FuncParam|sy|The scale Y axis}}
{{FuncParam|sz|__EDIT_ME__}}
{{FuncParam|sz|The scale Z axis}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' on success.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
local pickup = CreatePickup(1, x, y, z)
SetPickupScale(pickup, 10.0, 10.0, 10.0)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{Template:PickupFunctions}}

Latest revision as of 18:20, 30 August 2020

SetPickupScale

Type: Function
Context: Server
Introduced: v1.0

Description

Set's the size scaling of the pickup.

Syntax

SetPickupScale(pickup, sx, sy, sz)

Parameters

  • pickup
    The pickup identifier.
  • sx
    The scale X axis
  • sy
    The scale Y axis
  • sz
    The scale Z axis

Return Value

  • Returns true on success.

Example

local pickup = CreatePickup(1, x, y, z)
SetPickupScale(pickup, 10.0, 10.0, 10.0)

See also