World

Classes
interface	BaseWorld
interface	Decal
interface	LightHandle
interface	TraceBox
interface	TraceOBB
interface	TraceParam
	Input&Output structure for collision tests. More...
interface	TraceSphere
interface	TrackDecal
interface	WorldTimestamp
	Type storing timestamps of the world. More...
interface	SharedItem
interface	World
	derived class connected to gamelib to implement game related features More...

Typedefs
typedef func	QueryEntitiesCallback
typedef func	TraceFilterCallback
typedef func	AsyncTraceFinishedCallback

Enumerations
enum	CameraType { CameraType.NONE , CameraType.PERSPECTIVE , CameraType.ORTHOGRAPHIC }
enum	EQueryEntitiesFlags {   EQueryEntitiesFlags.STATIC , EQueryEntitiesFlags.DYNAMIC , EQueryEntitiesFlags.FEATURES , EQueryEntitiesFlags.WITH_OBJECT ,   EQueryEntitiesFlags.NO_PROXIES , EQueryEntitiesFlags.ALL }
enum	TraceFlags {   TraceFlags.ENTS , TraceFlags.WORLD , TraceFlags.OCEAN , TraceFlags.VISIBILITY ,   TraceFlags.ANY_CONTACT , TraceFlags.ALL_CONTACTS , TraceFlags.DEFAULT }
enum	PostProcessEffectType {   PostProcessEffectType.None , PostProcessEffectType.UnderWater , PostProcessEffectType.SSAO , PostProcessEffectType.DepthOfField ,   PostProcessEffectType.HBAO , PostProcessEffectType.RotBlur , PostProcessEffectType.GodRays , PostProcessEffectType.Rain ,   PostProcessEffectType.FilmGrain , PostProcessEffectType.RadialBlur , PostProcessEffectType.ChromAber , PostProcessEffectType.WetDistort ,   PostProcessEffectType.DynamicBlur , PostProcessEffectType.ColorGrading , PostProcessEffectType.Colors , PostProcessEffectType.HDR ,   PostProcessEffectType.SMAA , PostProcessEffectType.FXAA , PostProcessEffectType.Median , PostProcessEffectType.SunMask ,   PostProcessEffectType.GaussFilter , PostProcessEffectType.SSR , PostProcessEffectType.DepthOfFieldBokeh , PostProcessEffectType.ThermalImaging }
	Post-process effect type. More...

Functions
bool	QueryEntitiesCallback (IEntity e)
bool	TraceFilterCallback (notnull IEntity e, vector start="0 0 0", vector dir="0 0 0")
void	AsyncTraceFinishedCallback (notnull TraceParam param=null, float fraction=0)
TraceParam	MakeTraceParam (vector start, vector end, TraceFlags flags)

Detailed Description

Typedef Documentation

AsyncTraceFinishedCallback

typedef func AsyncTraceFinishedCallback

QueryEntitiesCallback

typedef func QueryEntitiesCallback

TraceFilterCallback

typedef func TraceFilterCallback

Enumeration Type Documentation

CameraType

enum CameraType

Enumerator
NONE
PERSPECTIVE
ORTHOGRAPHIC

EQueryEntitiesFlags

enum EQueryEntitiesFlags

Enumerator
STATIC	Include entities with enf::EntityFlags.TFL_STATIC.
DYNAMIC	Include entities without enf::EntityFlags.TFL_STATIC.
FEATURES	Include entities with enf::EntityFlags.TFL_FEATURE (usually large landscape parts as lakes, fake horizons etc)
WITH_OBJECT	Include only entities that has some VObjectComponent (Mesh, Particle etc)
NO_PROXIES	Do not include children entities with enf::EntityFlags.TFL_PROXY.
ALL

PostProcessEffectType

enum PostProcessEffectType

Post-process effect type.

Attention

Keep enum names in sync with post-process effect material class names. Postfix "Effect" is added automatically.

Enumerator
None
UnderWater
SSAO
DepthOfField
HBAO
RotBlur
GodRays
Rain
FilmGrain
RadialBlur
ChromAber
WetDistort
DynamicBlur
ColorGrading
Colors
HDR
SMAA
FXAA
Median
SunMask
GaussFilter
SSR
DepthOfFieldBokeh
ThermalImaging

TraceFlags

enum TraceFlags

Enumerator
ENTS	Tracing against entities.
WORLD	Tracing against terrain.
OCEAN	Tracing against ocean surface.
VISIBILITY	Trace also against visibility occluders, like particles.
ANY_CONTACT	Stop on any contact. The best for visibility testing.
ALL_CONTACTS	Do not stop on any contact, report them all through callback.
DEFAULT	Most common flag set.

Function Documentation

AsyncTraceFinishedCallback()

void AsyncTraceFinishedCallback	(	notnull TraceParam	param = null,
		float	fraction = 0 )

MakeTraceParam()

TraceParam MakeTraceParam	(	vector	start,
		vector	end,
		TraceFlags	flags )

QueryEntitiesCallback()

bool QueryEntitiesCallback

(

IEntity

e

)

TraceFilterCallback()

bool TraceFilterCallback	(	notnull IEntity	e,
		vector	start = "0 0 0",
		vector	dir = "0 0 0" )