SetOceanWaterLevel: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
 
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])}}

Latest revision as of 16:41, 22 April 2022

SetOceanWaterLevel

Type: Function
Context: Client
Introduced: v1.0

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__

See also