Ocean API

Collaboration diagram for Ocean API:

Functions
void	OcclusionQuery::~OcclusionQuery ()
proto native int	OcclusionQuery::GetResult ()
proto native void	OcclusionQuery::SetPosition (vector pos)
	Sets world position.
proto native void	OcclusionQuery::Destroy ()
	Destroys the object.
proto native bool	IsOcean ()
proto native float	GetOceanHeight (float worldX, float worldZ)
proto native vector	GetOceanHeightAndDisplace (float worldX, float worldZ)

Variables
float	TraceContact::Fraction
int	TraceContact::Content
int	TraceContact::Surfparm
int	TraceContact::MaterialFlags
int	TraceContact::Triangle
int	TraceContact::SurfaceID
owned string	TraceContact::MaterialName
owned string	TraceContact::OriginalMaterialName
float	TraceContact::Plane [4]
vector	TraceContact::Point
float	Fraction
int	Content
int	Surfparm
int	MaterialFlags
int	Triangle
int	SurfaceID
owned string	MaterialName
owned string	OriginalMaterialName
float	Plane [4]
vector	Point
vector	TraceParam::Start
vector	TraceParam::End
int	TraceParam::LayerMask = 0xffffffff
TraceFlags	TraceParam::Flags
IEntity	TraceParam::Exclude
float	TraceSphere::Radius
vector	TraceBox::Mins
vector	TraceBox::Maxs
vector	TraceOBB::Mat [3]

Detailed Description

Function Documentation

Destroy()

proto native void OcclusionQuery::Destroy ( )

private

Destroys the object.

GetOceanHeight()

proto native float GetOceanHeight	(	float	worldX,
		float	worldZ )

Get water ocean height at given point

Parameters

worldX	world x position
worldZ	world z position

GetOceanHeightAndDisplace()

proto native vector GetOceanHeightAndDisplace	(	float	worldX,
		float	worldZ )

Get water ocean height and displacement at given point, returns vector(displaceX, height, displaceZ)

Parameters

worldX	world x position
worldZ	world z position

GetResult()

proto native int OcclusionQuery::GetResult ( )

private

return Query result

Returns

-1 result is not ready yet, try it later. >0 point is visible ==0 point is not visible

IsOcean()

proto native bool IsOcean

(

)

Is ocean availabled

SetPosition()

proto native void OcclusionQuery::SetPosition ( vector pos )

private

Sets world position.

~OcclusionQuery()

void OcclusionQuery::~OcclusionQuery ( )

private

Variable Documentation

Content [1/2]

int Content

Definition at line 1 of file EnWorld.c.

Content [2/2]

int TraceContact::Content

private

Definition at line 196 of file EnWorld.c.

End

vector TraceParam::End

private

Definition at line 214 of file EnWorld.c.

Exclude

IEntity TraceParam::Exclude

private

Definition at line 217 of file EnWorld.c.

Flags

TraceFlags TraceParam::Flags

private

Definition at line 216 of file EnWorld.c.

Fraction [1/2]

float Fraction

Definition at line 0 of file EnWorld.c.

Fraction [2/2]

float TraceContact::Fraction

private

Definition at line 195 of file EnWorld.c.

LayerMask

int TraceParam::LayerMask = 0xffffffff

private

Definition at line 215 of file EnWorld.c.

Mat

vector TraceOBB::Mat[3]

private

Definition at line 234 of file EnWorld.c.

MaterialFlags [1/2]

int MaterialFlags

Definition at line 3 of file EnWorld.c.

MaterialFlags [2/2]

int TraceContact::MaterialFlags

private

Definition at line 198 of file EnWorld.c.

MaterialName [1/2]

owned string MaterialName

Definition at line 6 of file EnWorld.c.

MaterialName [2/2]

owned string TraceContact::MaterialName

private

Definition at line 201 of file EnWorld.c.

Maxs

vector TraceBox::Maxs

private

Definition at line 229 of file EnWorld.c.

Mins

vector TraceBox::Mins

private

Definition at line 228 of file EnWorld.c.

OriginalMaterialName [1/2]

owned string OriginalMaterialName

Definition at line 7 of file EnWorld.c.

OriginalMaterialName [2/2]

owned string TraceContact::OriginalMaterialName

private

Definition at line 202 of file EnWorld.c.

Plane [1/2]

float Plane[4]

Definition at line 8 of file EnWorld.c.

Plane [2/2]

float TraceContact::Plane[4]

private

Definition at line 203 of file EnWorld.c.

Point [1/2]

vector Point

Definition at line 9 of file EnWorld.c.

Point [2/2]

vector TraceContact::Point

private

Definition at line 204 of file EnWorld.c.

Radius

float TraceSphere::Radius

private

Definition at line 223 of file EnWorld.c.

Start

vector TraceParam::Start

private

Definition at line 213 of file EnWorld.c.

SurfaceID [1/2]

int SurfaceID

Definition at line 5 of file EnWorld.c.

SurfaceID [2/2]

int TraceContact::SurfaceID

private

Definition at line 200 of file EnWorld.c.

Surfparm [1/2]

int Surfparm

Definition at line 2 of file EnWorld.c.

Surfparm [2/2]

int TraceContact::Surfparm

private

Definition at line 197 of file EnWorld.c.

Triangle [1/2]

int Triangle

Definition at line 4 of file EnWorld.c.

Triangle [2/2]

int TraceContact::Triangle

private

Definition at line 199 of file EnWorld.c.