Class SharedWater

Class used to create bodies of water on the map

Inheritance
Object
Element
PhysicalElement
SharedWater
Inherited Members
Namespace: Slipe.Shared.GameWorld
Assembly: SlipeShared.dll
Syntax
public class SharedWater : PhysicalElement

Constructors

| Improve this Doc View Source

SharedWater(Vector3, Vector3, Vector3, Boolean)

Creates a body of water from 3 corners. Order: SouthWest -> SouthEast -> NorthWest

Declaration
public SharedWater(Vector3 southWest, Vector3 southEast, Vector3 northWest, bool shallow = false)
Parameters
Type Name Description
Vector3 southWest
Vector3 southEast
Vector3 northWest
Boolean shallow
| Improve this Doc View Source

SharedWater(Vector3, Vector3, Vector3, Vector3, Boolean)

Creates a body of water from 4 corners. Order: SouthWest -> SouthEast -> NorthWest -> NorthEast

Declaration
public SharedWater(Vector3 southWest, Vector3 southEast, Vector3 northWest, Vector3 northEast, bool shallow = false)
Parameters
Type Name Description
Vector3 southWest
Vector3 southEast
Vector3 northWest
Vector3 northEast
Boolean shallow

Properties

| Improve this Doc View Source

Level

Get the level of this water element

Declaration
public float Level { set; }
Property Value
Type Description
Single

Methods

| Improve this Doc View Source

GetVertexPosition(Int32)

Gets the world position of a vertex (i.e. corner) of a water area. Follow the order SW, SE, NW, NE

Declaration
public Vector3 GetVertexPosition(int vertexIndex)
Parameters
Type Name Description
Int32 vertexIndex
Returns
Type Description
Vector3
| Improve this Doc View Source

SetVertexPosition(Int32, Vector3)

Sets the water position of a specific index follow the order SW, SE, NW, NE

Declaration
public bool SetVertexPosition(int vertexIndex, Vector3 position)
Parameters
Type Name Description
Int32 vertexIndex
Vector3 position
Returns
Type Description
Boolean