SetPickupDimension: Difference between revisions
From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|Sets the dimension of this pickup. Players can only see pickups in the same dimension. * Default dimension: 0 * Maximum dimens...") |
No edit summary |
||
| Line 11: | Line 11: | ||
{{FuncParam|dimension|The new dimension to set.}} | {{FuncParam|dimension|The new dimension to set.}} | ||
{{FuncReturnValue| | {{FuncReturnValue|Returns '''true''' on success.}} | ||
== Example == | == Example == | ||
<syntaxhighlight lang="Lua"> | |||
SetPickupDimension(pickup, 0) -- Set the pickup dimension to 0 | |||
</syntaxhighlight> | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
{{PickupFunctions}} | |||
Latest revision as of 15:10, 7 January 2020
Description
Sets the dimension of this pickup. Players can only see pickups in the same dimension.
- Default dimension: 0
- Maximum dimension: 4294967295
Syntax
SetPickupDimension(pickup, dimension)
Parameters
- pickup
The pickup identifier. - dimension
The new dimension to set.
Return Value
- Returns true on success.
Example
SetPickupDimension(pickup, 0) -- Set the pickup dimension to 0
See also
- GetPickupCount
- GetStreamedPickups
- GetPickupLocation
- SetPickupPropertyValue
- GetPickupPropertyValue
- SetPickupVisibleForPlayers
- GetAllPickups
- CreatePickup
- DestroyPickup
- IsValidPickup
- SetPickupScale
- GetPickupScale
- SetPickupDimension
- GetPickupDimension
- SetPickupVisibility
- SetPickupOutline
- IsPickupStreamedIn
