Classes
class	BaseWorld
class	Decal
class	LightHandle
class	TraceBox
class	TraceOBB
class	TraceParam
class	TraceSphere
class	TrackDecalFactory
class	WorldTimestamp
class	BaseTimeAndWeatherManagerEntityClass
class	FlagAnimationComponent
class	FlagAnimationComponentClass
class	LocalWeatherSituation
class	World

Typedefs
typedef func	QueryEntitiesCallback
typedef func	TraceFilterCallback
typedef func	AsyncTraceFinishedCallback

Enumerations
enum	CameraType { NONE , PERSPECTIVE , ORTHOGRAPHIC , NONE , PERSPECTIVE , ORTHOGRAPHIC }
enum	CameraType { NONE , PERSPECTIVE , ORTHOGRAPHIC , NONE , PERSPECTIVE , ORTHOGRAPHIC }
enum	EQueryEntitiesFlags { STATIC , DYNAMIC , FEATURES , WITH_OBJECT , NO_PROXIES , ALL , STATIC , DYNAMIC , FEATURES , WITH_OBJECT , NO_PROXIES , ALL }
enum	EQueryEntitiesFlags { STATIC , DYNAMIC , FEATURES , WITH_OBJECT , NO_PROXIES , ALL , STATIC , DYNAMIC , FEATURES , WITH_OBJECT , NO_PROXIES , ALL }
enum	TraceFlags { ENTS , WORLD , OCEAN , VISIBILITY , ANY_CONTACT , ALL_CONTACTS , DEFAULT , ENTS , WORLD , OCEAN , VISIBILITY , ANY_CONTACT , ALL_CONTACTS , DEFAULT }
enum	TraceFlags { ENTS , WORLD , OCEAN , VISIBILITY , ANY_CONTACT , ALL_CONTACTS , DEFAULT , ENTS , WORLD , OCEAN , VISIBILITY , ANY_CONTACT , ALL_CONTACTS , DEFAULT }
enum	PostProcessEffectType

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)
enum PostProcessEffectType	MakeTraceParam (vector start, vector end, TraceFlags flags)
BaseTimeAndWeatherManagerEntityClass BaseWeatherManagerEntityClass	IsNightHour (float hour24)
proto external bool	IsDayHour (float hour24)
proto void	SetTimeEvent (string time, Managed inst, func callback, bool delayed=true, bool singleUse=false)
proto external bool	TryGetCompleteLocalWeather (LocalWeatherSituation lws, float swayFrequency, vector location)

Detailed Description

Typedef Documentation

◆ AsyncTraceFinishedCallback

typedef func AsyncTraceFinishedCallback

Definition at line 12 of file EnWorld.c.

◆ QueryEntitiesCallback

typedef func QueryEntitiesCallback

Definition at line 6 of file EnWorld.c.

◆ TraceFilterCallback

typedef func TraceFilterCallback

Definition at line 9 of file EnWorld.c.

Enumeration Type Documentation

◆ CameraType [1/2]

enum CameraType

Enumerator
NONE
PERSPECTIVE
ORTHOGRAPHIC
NONE
PERSPECTIVE
ORTHOGRAPHIC

Definition at line 13 of file CameraType.c.

◆ CameraType [2/2]

enum CameraType

Enumerator
NONE
PERSPECTIVE
ORTHOGRAPHIC
NONE
PERSPECTIVE
ORTHOGRAPHIC

Definition at line 13 of file CameraType.c.

◆ EQueryEntitiesFlags [1/2]

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
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

Definition at line 12 of file EQueryEntitiesFlags.c.

◆ EQueryEntitiesFlags [2/2]

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
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

Definition at line 12 of file EQueryEntitiesFlags.c.

◆ 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.

Definition at line 19 of file EnWorld.c.

◆ TraceFlags [1/2]

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.
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.

Definition at line 12 of file TraceFlags.c.

◆ TraceFlags [2/2]

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.
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.

Definition at line 12 of file TraceFlags.c.

Function Documentation

◆ AsyncTraceFinishedCallback()

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

◆ IsDayHour()

proto external bool IsDayHour ( float hour24 )

◆ IsNightHour()

BaseTimeAndWeatherManagerEntityClass BaseWeatherManagerEntityClass IsNightHour ( float hour24 )

Manager entity responsible for managing in-game time and weather, providing the script and gamecode with usable in-game API.

◆ MakeTraceParam()

enum PostProcessEffectType MakeTraceParam	(	vector	start,
		vector	end,
		TraceFlags	flags )

Definition at line 13 of file EnWorld.c.

◆ QueryEntitiesCallback()

bool QueryEntitiesCallback ( IEntity e )

◆ SetTimeEvent()

proto void SetTimeEvent	(	string	time,
		Managed	inst,
		func	callback,
		bool	delayed = true,
		bool	singleUse = false )

◆ TraceFilterCallback()

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

◆ TryGetCompleteLocalWeather()

proto external bool TryGetCompleteLocalWeather	(	LocalWeatherSituation	lws,
		float	swayFrequency,
		vector	location )

Returns all information about current weather - rain, fog, overcast, wind. If swayFrequency and location are set, sway is calculated as well (works as with trees and grass). Mind that wetness and water accumulation effects are WIP and they will not be set yet. You can use ref LocalWeatherSituation weatherSituation = new LocalWeatherSituation(); to create the object and pass it as an argument.

Classes

Typedefs

Enumerations

Functions