SetOceanWaterLevel: Difference between revisions
From Onset Developer Wiki
No edit summary |
No edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Info|Function|Client|1.0}} | {{Info|Function|Client|1.0}} | ||
{{FuncDescription|Sets the ocean water level to a specific height.}} | {{FuncDescription|Sets the ocean water level to a specific height. Basically the ''Z'' location (height).}} | ||
{{FuncSyntax|SetOceanWaterLevel(Level [, bIncludeSwimmingVolume])}} | {{FuncSyntax|SetOceanWaterLevel(Level [, bIncludeSwimmingVolume])}} | ||
| Line 7: | Line 7: | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|Level|Water level from -200 to 10000}} | {{FuncParam|Level|Water level from -200 to 10000}} | ||
{{FuncParamOptional|bIncludeSwimmingVolume| | {{FuncParamOptional|bIncludeSwimmingVolume|Whether the swimming volume should also be set to the water level. ''false'' means you will be able to walk underwater.}} | ||
{{FuncReturnValue|This function does not return anything.}} | {{FuncReturnValue|This function does not return anything.}} | ||
| Line 15: | Line 15: | ||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
* [[SetOceanWaterLevel]] | |||
* [[SetOceanColor]] | |||
* [[ResetOceanColor]] | |||
Latest revision as of 16:41, 22 April 2022
Description
Sets the ocean water level to a specific height. Basically the Z location (height).
Syntax
SetOceanWaterLevel(Level [, bIncludeSwimmingVolume])
Parameters
- Level
Water level from -200 to 10000 - bIncludeSwimmingVolume (optional)
Whether the swimming volume should also be set to the water level. false means you will be able to walk underwater.
Return Value
- This function does not return anything.
Example
__EDIT_ME__
