SetOceanWaterLevel: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
Line 7: Line 7:
{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|Level|Water level from -200 to 10000}}
{{FuncParam|Level|Water level from -200 to 10000}}
{{FuncParamOptional|bIncludeSwimmingVolume|Wheter the swimming volume should also be set to the water level. ''false'' means you will be able to walk underwater.}}
{{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}}
__EDIT_ME__
* [[SetOceanWaterLevel]]
* [[SetOceanColor]]
* [[ResetOceanColor]]

Revision as of 19:08, 18 November 2019

SetOceanWaterLevel

Type: Function
Context: Client
Introduced: v1.0

Description

Sets the ocean water level to a specific 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__

See also