Entities

Classes
class	EntityComponentPrefabData
class	EntityPrefabData
class	IEntity
class	NativeComponent
class	BaseChatEntityClass
class	BaseGameEntityClass
class	DestructibleEntity
class	DestructibleEntityClass
class	DestructionManagerClass
class	EntityUtils
class	GameEntityClass
class	GameEnvironmentProbeEntityClass
class	MusicManagerClass
class	PowerlineEntityClass
	Represents a single segment of power line grid between two power poles. More...
class	PowerPoleEntityClass
class	RadioManagerEntityClass
class	RegionalDestructionManagerClass
class	SoundWorldClass
class	TurretClass
class	VehiclePartPanelClass
class	VehiclePartRotorClass
class	BaseWeatherManagerEntityClass
class	CharacterEntity
class	CharacterEntityClass
class	CinematicEntityClass
class	DecalEntityClass
class	DeferredDecalEntityClass
class	EnvironmentProbeEntityClass
class	GeneratorBaseEntityClass
class	GenericControllerClass
class	GenericEntity
class	GenericTerrainEntityClass
class	GenericWorldEntityClass
class	GenericWorldFogEntityClass
class	GenericWorldLightEntityClass
class	GenericWorldPPEffectClass
class	GenericWorldRainEntityClass
class	GenericWorldWindEntityClass
class	LakeGeneratorEntityClass
class	LightEntityClass
class	PawnEntity
class	PawnEntityClass
class	PawnRelatedEntity
class	PawnRelatedEntityClass
class	PolylineShapeEntityClass
class	ProbeVolumeClass
class	RagdollTestEntityClass
class	RiverEntityClass
class	RiverPartEntityClass
class	RoadEntityClass
class	ShapeEntityClass
class	SimpleCustomConcaveGeometryEntityClass
class	SplineShapeEntityClass
class	SplineTerrainGeneratorEntityBaseClass
class	StaticModelEntityClass
class	TreeEntity
class	TreeEntityClass
class	VolumeEntityClass
class	VolumeReceiverEntityClass
class	WorldOccluderEntityClass

Enumerations
enum	EAddChildFlags {   NONE , AUTO_TRANSFORM , RECALC_LOCAL_TRANSFORM , MERGE_PHYSICS ,   NONE , AUTO_TRANSFORM , RECALC_LOCAL_TRANSFORM , MERGE_PHYSICS }
enum	EAddChildFlags {   NONE , AUTO_TRANSFORM , RECALC_LOCAL_TRANSFORM , MERGE_PHYSICS ,   NONE , AUTO_TRANSFORM , RECALC_LOCAL_TRANSFORM , MERGE_PHYSICS }
enum	EntityEvent {   TOUCH , INIT , VISIBLE , FRAME ,   POSTFRAME , ANIMEVENT , SIMULATE , POSTSIMULATE ,   JOINTBREAK , PHYSICSMOVE , CONTACT , PHYSICSACTIVE ,   FIXEDFRAME , POSTFIXEDFRAME , USER3 , USER4 ,   USER5 , DISABLED = 0 , ALL , TOUCH ,   INIT , VISIBLE , FRAME , POSTFRAME ,   ANIMEVENT , SIMULATE , POSTSIMULATE , JOINTBREAK ,   PHYSICSMOVE , CONTACT , PHYSICSACTIVE , FIXEDFRAME ,   POSTFIXEDFRAME , USER3 , USER4 , USER5 ,   DISABLED = 0 , ALL }
	Various entity events. More...
enum	EntityEvent {   TOUCH , INIT , VISIBLE , FRAME ,   POSTFRAME , ANIMEVENT , SIMULATE , POSTSIMULATE ,   JOINTBREAK , PHYSICSMOVE , CONTACT , PHYSICSACTIVE ,   FIXEDFRAME , POSTFIXEDFRAME , USER3 , USER4 ,   USER5 , DISABLED = 0 , ALL , TOUCH ,   INIT , VISIBLE , FRAME , POSTFRAME ,   ANIMEVENT , SIMULATE , POSTSIMULATE , JOINTBREAK ,   PHYSICSMOVE , CONTACT , PHYSICSACTIVE , FIXEDFRAME ,   POSTFIXEDFRAME , USER3 , USER4 , USER5 ,   DISABLED = 0 , ALL }
enum	EntityFlags {   VISIBLE , TRACEABLE , NO_LINK , FEATURE ,   SET_RENDERED , STREAMABLE , ACTIVE , STATIC ,   USER1 , USER2 , USER3 , USER4 ,   USER5 , NO_TREE , RELATIVE_Y , EDITOR_ONLY ,   DISABLED , PROXY , UPDATE_LINK , VISIBLE ,   TRACEABLE , NO_LINK , FEATURE , SET_RENDERED ,   STREAMABLE , ACTIVE , STATIC , USER1 ,   USER2 , USER3 , USER4 , USER5 ,   NO_TREE , RELATIVE_Y , EDITOR_ONLY , DISABLED ,   PROXY , UPDATE_LINK }
	Various entity flags. More...
enum	EntityFlags {   VISIBLE , TRACEABLE , NO_LINK , FEATURE ,   SET_RENDERED , STREAMABLE , ACTIVE , STATIC ,   USER1 , USER2 , USER3 , USER4 ,   USER5 , NO_TREE , RELATIVE_Y , EDITOR_ONLY ,   DISABLED , PROXY , UPDATE_LINK , VISIBLE ,   TRACEABLE , NO_LINK , FEATURE , SET_RENDERED ,   STREAMABLE , ACTIVE , STATIC , USER1 ,   USER2 , USER3 , USER4 , USER5 ,   NO_TREE , RELATIVE_Y , EDITOR_ONLY , DISABLED ,   PROXY , UPDATE_LINK }
enum	EntityVisualizerType {   EVT_NONE , EVT_NORMAL , EVT_SELECTED , EVT_SELECTED_AS_MAIN ,   EVT_UNDER_CURSOR , EVT_NONE , EVT_NORMAL , EVT_SELECTED ,   EVT_SELECTED_AS_MAIN , EVT_UNDER_CURSOR }
	Game editor entity visualizer type. More...
enum	EntityVisualizerType {   EVT_NONE , EVT_NORMAL , EVT_SELECTED , EVT_SELECTED_AS_MAIN ,   EVT_UNDER_CURSOR , EVT_NONE , EVT_NORMAL , EVT_SELECTED ,   EVT_SELECTED_AS_MAIN , EVT_UNDER_CURSOR }
enum	PointChangedSituation {   PCS_MOVED_FROM , PCS_MOVED_TO , PCS_ADDED , PCS_REMOVED ,   PCS_BEFORE_DATA_CHANGED , PCS_AFTER_DATA_CHANGED , PCS_BEFORE_TANGENT_CHANGED , PCS_AFTER_TANGENT_CHANGED ,   PCS_MOVED_FROM , PCS_MOVED_TO , PCS_ADDED , PCS_REMOVED ,   PCS_BEFORE_DATA_CHANGED , PCS_AFTER_DATA_CHANGED , PCS_BEFORE_TANGENT_CHANGED , PCS_AFTER_TANGENT_CHANGED }
enum	PointChangedSituation {   PCS_MOVED_FROM , PCS_MOVED_TO , PCS_ADDED , PCS_REMOVED ,   PCS_BEFORE_DATA_CHANGED , PCS_AFTER_DATA_CHANGED , PCS_BEFORE_TANGENT_CHANGED , PCS_AFTER_TANGENT_CHANGED ,   PCS_MOVED_FROM , PCS_MOVED_TO , PCS_ADDED , PCS_REMOVED ,   PCS_BEFORE_DATA_CHANGED , PCS_AFTER_DATA_CHANGED , PCS_BEFORE_TANGENT_CHANGED , PCS_AFTER_TANGENT_CHANGED }

Functions
BaseChatEntityClass GenericEntityClass	GetChannelsCount ()
proto external string	GetChannelName (int channelId)
proto external BaseChatChannel	GetChannel (int channelId)
proto external PrivateMessageChannel	GetWhisperChannel ()
proto external BaseChatChannel	GetDefaultChannel ()
proto external BaseChatChannelStyle	GetStyle ()
BaseGameEntityClass GenericEntityClass	Teleport (vector mat[4])
proto external RplComponent	GetRplComponent ()
	Returns the replication component associated to this entity.
DestructionManagerClass GenericEntityClass	GetOrCreateRegionalDestructionManager (const vector position)
proto external void	QueueDestructionHeatmapEntry (notnull DestructionHeatmapEntry entryData)
MusicManagerClass GenericEntityClass	Play (string musicName)
	'Forces' a sound to play without taking into account the automated evaluation process
proto external void	Stop (string musicName)
	Stops either a specific Music that is playing by name OR stops whatever is currently playing (when the string is empty).
proto external void	MuteCategory (MusicCategory musicCategory, bool mute, bool stopNow)
	(Un)Mutes a category locally. Does not influence any categories muted from server side
proto external void	RequestServerMuteCategory (MusicCategory musicCategory, bool mute)
	Requests server (from any client) to mute a category on the server, this muted category is seperated from your own (locally) muted categories.
proto external bool	ServerIsCategoryMuted (MusicCategory musicCategory)
	Checks whether a given category is muted by the server (game master).
proto external void	SetManagerSignals ()
	Sets default used MusicManager signals.
proto external int	GetSignalIndex (string name)
	Get index for signal name. Return -1 if signal not found.
proto external void	SetSignalValue (int index, float value)
	Set signal value by 'index'. Index is obtained by GetSignalIndex method.
proto external void	SetSignalValueStr (string signal, float value)
	Set signal value by signal name.
RadioManagerEntityClass GenericEntityClass	GetTransceiversInRange (vector position, float range, out notnull array< BaseTransceiver > tsvList)
RegionalDestructionManagerClass GenericEntityClass	OnSave (notnull ScriptBitWriter writer)
event bool	OnLoad (notnull ScriptBitReader reader)
SoundWorldClass GenericEntityClass	GetMapValuesAtPos (vector pos, out float sea, out float forest, out float city, out float meadow)
proto void	GetMapValuesAdvAtPos (vector pos, out float river, out float riverSlope, out float lake, out float coast)
proto void	CalculateInterirorAt (vector pos, InteriorRequestCallback callback)
BaseWeatherManagerEntityClass GenericEntityClass	GetCurrentWeatherState ()
proto external float	GetDayDuration ()
proto external bool	SetDayDuration (float realtimeSeconds)
proto external bool	SetIsDayAutoAdvanced (bool autoAdvanced)
proto external bool	GetIsDayAutoAdvanced ()
proto external bool	SetCurrentLongitude (float longitude)
proto external float	GetCurrentLongitude ()
proto external float	GetCurrentLatitude ()
proto external bool	SetCurrentLatitude (float latitude)
proto external float	GetTimeZoneOffset ()
proto external bool	SetTimeZoneOffset (float utcTimeZone)
proto external float	GetDSTOffset ()
proto external bool	SetDSTOffset (float dstOffsetHours)
proto external bool	IsDSTEnabled ()
proto external bool	SetDSTEnabled (bool enabled)
proto external bool	SetWindSpeedOverride (bool doOverride, float windSpeed=0)
proto external float	GetWindSpeed ()
proto external bool	SetWindDirectionOverride (bool doOverride, float windDirection=0)
proto external float	GetWindDirection ()
proto external bool	IsWindSpeedOverridden ()
proto external bool	IsWindDirectionOverridden ()
proto external bool	SetRainIntensityOverride (bool doOverride, float rainIntensity=0)
proto external float	GetRainIntensity ()
proto external bool	IsRainIntensityOverridden ()
proto external bool	SetFogAmountOverride (bool doOverride, float fog=0)
proto external bool	SetFogHeightDensityOverride (bool doOverride, float heightDensity=0)
proto external float	GetFogAmount ()
proto external bool	IsFogAmountOverridden ()
proto external float	GetFogHeightDensity ()
proto external bool	IsFogHeightDensityOverridden ()
proto external bool	SetCurrentWetness (float wetness)
proto external float	GetCurrentWetness ()
proto external bool	SetCurrentWaterAccumulation (float waterAccumulationCracks, float waterAccumulationPuddles)
proto external float	GetCurrentWaterAccumulationCracks ()
proto external float	GetCurrentWaterAccumulationPuddles ()
proto external void	AddLightning (WeatherLightning lightning)
proto BaseWeatherStateTransitionManager	GetTransitionManager ()
proto float	GetMoonPhaseForDate (int year, int month, int day, float timeOfTheDay24, float timezone, float dstOffset)
proto void	GetCurrentSunMoonDirAndPhase (out vector outSunDir, out vector outMoonDir, out float outMoonPhase01)
proto bool	GetSunriseHour (out float hour24)
proto bool	GetSunsetHour (out float hour24)
proto bool	GetSunriseHourForDate (int year, int month, int day, float latitude, float longitude, float timezone, float dstOffset, out float hour24)
proto bool	GetSunsetHourForDate (int year, int month, int day, float latitude, float longitude, float timezone, float dstOffset, out float hour24)
proto external float	GetTimeOfTheDay ()
proto external bool	SetTimeOfTheDay (float hours24, bool immediateChange=false)
proto external bool	SetHoursMinutesSeconds (int hours, int minutes, int seconds, bool immediateChange=false)
proto external int	GetYear ()
proto external int	GetMonth ()
proto external int	GetDay ()
proto external int	GetDayInYear ()
proto external bool	SetDate (int year, int month, int day, bool immediateChange=false)
proto void	GetDate (out int year, out int month, out int day)
proto void	GetHoursMinutesSeconds (out int hours, out int minutes, out int seconds)
proto external int	GetWeekDay ()
proto external int	GetWeekDayForDate (int year, int month, int day)
proto external float	GetEngineTime ()
proto external void	GetWeatherStatesList (out notnull array< ref WeatherState > outStates)
proto external float	GetMoonPhase (float timeOfTheDay24)
proto external bool	SetOverrideSunIrradiance (bool doOverride)
proto external bool	GetOverrideSunIrradiance ()
proto external bool	SetSunIrradianceOverrideValues (float sunIrradianceMin, float sunIrradianceMax)
proto external float	GetSunIrradianceMinOverride ()
proto external float	GetSunIrradianceMaxOverride ()
proto external bool	SetOverrideTemperature (bool doOverride)
proto external bool	GetOverrideTemperature ()
proto external bool	SetTemperatureOverrideValues (float temperatureAirMin, float temperatureAirMax, float temperatureSkyMin, float temperatureSkyMax, float temperatureWaterMin, float temperatureWaterMax)
proto external float	GetTemperatureAirMinOverride ()
proto external float	GetTemperatureAirMaxOverride ()
proto external float	GetTemperatureWaterMinOverride ()
proto external float	GetTemperatureWaterMaxOverride ()
proto external float	GetTemperatureSkyMinOverride ()
proto external float	GetTemperatureSkyMaxOverride ()
proto external bool	ForceTemperatureTableRecompute ()
proto external bool	CheckValidDate (int year, int month, int day)
proto external void	UpdateWeather (float timeSlice, bool advanceSimulation=true)
CinematicEntityClass GenericEntityClass	Play ()
	Start playing the animation. Call 'Prepare' first if you need to change the setup of a component!
proto external void	Pause ()
proto external void	Stop ()
	Stop tracking time in this menu, prepare for sending data.
proto external bool	IsPlaying ()
proto external bool	Isfinished ()
proto external void	AttachCameraToEntity (IEntity ent, int pivotIndex, vector positionOffset, vector anglesOffset)
proto external void	DetachCamera ()
proto external void	PlayCameraAnimation (ResourceName animFile, string boneName, float startTimeOffset)
proto external void	PlayCameraAnimationExt (ResourceName animFile, string boneName, float startTimeOffset, vector upVec, vector asideVec)
proto external void	StopCameraAnimation ()
proto external void	SetOnFinishedCallback (func fn)
EnvironmentProbeEntityClass VolumeReceiverEntityClass	SetProbePosition (vector position, bool invalidate)
proto external void	Recapture ()
proto external void	EnableUserEV (float EV, bool absolute)
proto external void	DisableUserEV ()
proto external float	GetUserEV (float EV)
proto external void	SetReflectionEV (float EV)
proto external void	SetDiffuseEV (float EV)
proto external int	GetVolumesCount ()
proto external int	GetVolumeIndex (string volumeName)
proto external string	GetVolumeName (int index)
proto external void	EnableVolume (int index, bool On)
proto external bool	IsVolumeEnabled (int index)
GeneratorBaseEntityClass GenericEntityClass	OnShapeInit (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity)
proto external void	BeforeShapeTransform (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, inout vector oldTransform[4])
proto external void	OnShapeTransform (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, array< vector > mins, array< vector > maxes)
proto external void	OnShapeChanged (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, array< vector > mins, array< vector > maxes)
proto external void	OnPointDataChanged (IEntitySource src, ShapeEntity shapeEntity, PointChangedSituation situation, string propertyID, array< int > pointIndices)
proto external void	OnPointChanged (IEntitySource src, ShapeEntity shapeEntity, PointChangedSituation situation, int pointIndex, vector position)
proto external void	OnAnchorSnapped (IEntitySource shapeEntitySrc, int parentAnchor, IEntitySource other, int otherAnchor, bool isReciever)
proto external bool	CanAnchorSnap (IEntitySource shapeEntitySrc, int parentAnchor, IEntitySource other, int otherAnchor, bool isReciever)
proto external void	OnIntersectingShapeChangedXZ (IEntitySource shapeEntitySrc, IEntitySource other, array< vector > mins, array< vector > maxes)
void	OnShapeInitInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity)
void	BeforeShapeTransformInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, inout vector oldTransform[4])
void	OnShapeTransformInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, array< vector > mins, array< vector > maxes)
void	OnShapeChangedInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, array< vector > mins, array< vector > maxes)
void	OnPointDataChangedInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, PointChangedSituation situation, string propertyID, array< int > pointIndices)
void	OnPointChangedInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, PointChangedSituation situation, int pointIndex, vector position)
void	OnAnchorSnappedInternal (IEntitySource shapeEntitySrc, int parentAnchor, IEntitySource other, int otherAnchor, bool isReciever)
bool	CanAnchorSnapInternal (IEntitySource shapeEntitySrc, int parentAnchor, IEntitySource other, int otherAnchor, bool isReciever)
void	OnIntersectingShapeChangedXZInternal (IEntitySource shapeEntitySrc, IEntitySource other, array< vector > mins, array< vector > maxes)
GenericTerrainEntityClass GenericEntityClass	AffectFoliageEllipse (vector position, vector velocity, float height, float sizeX, float sizeZ, float maskOffset, float angleRAD, float strength=1.0, float falloffOffset=0.5, bool flatten=true, bool sway=true)
proto external void	AffectFoliageCircle (vector position, vector velocity, float height, float diameter, float strength=1.0, float falloffOffset=0.5, bool flatten=true, bool sway=true)
proto external void	AffectFoliageRect (vector position, vector velocity, float height, float sizeX, float sizeZ, float maskOffset, float angleRAD, float strength=1.0, float falloffOffset=0.5, bool flatten=true, bool sway=true)
proto external void	AffectFoliageSquare (vector position, vector velocity, float height, float size, float angleRAD, float strength=1.0, float falloffOffset=0.5, bool flatten=true, bool sway=true)
proto bool	GetTileTextureResName (int tile, out ResourceName textureResName)
proto external int	GetTileNumber (int terrx, int terry)
proto external vector	WorldToTerrCoord (vector worldpos)
proto external vector	TerrToWorldCoord (vector terrpos)
proto bool	TryGetHeightTC (float x, float z, out float y)
proto external int	GetTileSizeTC ()
proto external void	GetTerrainBoundBox (out vector mins, out vector maxs)
proto external int	GetTileVerticesCount ()
GenericWorldEntityClass GenericEntityClass	GetTerrain (float x, float z)
proto external ref Material	GetSkyMaterial ()
LightEntityClass GenericEntityClass	CreateLight (LightType type, LightFlags flags, float radius, Color color, float LV, vector position, vector direction=vector.Forward)
proto external void	SetEnabled (bool state)
proto external bool	IsEnabled ()
	Returns true if the light is enabled.
proto external int	SetLightFlags (LightFlags flags)
proto external int	ClearLightFlags (LightFlags flags)
proto external bool	IsLightFlagsSet (LightFlags flags)
	Returns true if the flags is set.
proto external bool	IsDynamic ()
	Returns true if the light is dynamic, false otherwise.
proto external void	SetCastShadow (bool enable)
proto external bool	IsCastShadow ()
	Returns true if the light is casting shadows.
proto external void	SetColor (Color color, float LV)
proto external void	SetRadius (float radius)
proto external float	GetRadius ()
	Returns the current radius of the light in meters.
proto external void	SetIntensityEVClip (float clipEV)
proto external void	SetConeAngle (float angle)
proto external void	SetDistanceAtt (float att)
proto external void	SetConeAngleAttenuation (float coneAngleAttenuation)
proto external float	GetConeAngle ()
	Returns the current cone angle in degrees (useful for LightType.SPOT only).
proto external void	SetTexture (ResourceName textureName)
proto external void	SetNearPlane (float nearPlane)
proto external float	GetNearPlane ()
	Returns the current near plane of the light in meters.
proto external void	SetVolumeEffect (float intensity, float offset, float scale)
proto external void	SetLensFlareType (LightLensFlareType type)
proto external void	SetLensFlareIndex (int index)
proto external void	SetLensFlareScale (float scale)
proto external void	SetLensFlareOffset (vector offset)
proto external void	SetLightDirection (vector direction)
proto external int	SetLightCameraMask (int mask)
RiverEntityClass GeneratorBaseEntityClass	GetExistingInstances (out notnull array< RiverEntity > instances)
proto bool	GetCentralPolyline (out notnull array< vector > dstPositions, out notnull array< float > dstWidths, float precision=0.1)
proto void	GetOutlinePoints (out notnull array< vector > dst, float precision=0.1)
RoadEntityClass GenericEntityClass	WB_EnableAutoReinits ()
proto external void	WB_DisableAutoReinits ()
ShapeEntityClass GenericEntityClass	GetPointContainerOfType (IEntitySource src, int anchorIdx, string type)
proto external void	SetPoints (array< vector > points, IEntitySource entSource, int placeFirstAtIdx=0)
proto external void	GenerateTesselatedShape (notnull array< vector > outPoints)
proto void	GetAllInfluenceBBoxes (IEntitySource shapeEntitySrc, out notnull array< vector > mins, out notnull array< vector > maxes)
proto void	GetInfluenceBBoxesInSegments (IEntitySource shapeEntitySrc, int firstIncl, int lastIncl, out notnull array< vector > mins, out notnull array< vector > maxes)
proto external int	GetPointCount ()
proto external bool	IsClosed ()
proto external void	GetPointsPositions (notnull array< vector > outPoints)
	Copies positions of points to given array.
proto external void	AddPointData (IEntitySource entSrc, int idx, ShapePointDataScriptBase pointData)
SplineShapeEntityClass ShapeEntityClass	HasPointExplicitTangents (int pointIdx)
proto external void	SetPointsSpline (array< vector > points, IEntitySource entSource, float tangentLengthIn, float tangentLengthOut, int placeFirstAtIdx=0)
proto void	GetTangents (int pointIdx, out vector inTangent, out vector outTangent)
SplineTerrainGeneratorEntityBaseClass GeneratorBaseEntityClass	GetSegmentBoundBoxes (inout notnull array< vector > mins, inout notnull array< vector > maxs)
proto external void	RegisterGenerator (vector bbMin, vector bbMax, int priority)
proto external void	RemoveGenerator (bool forceUpdate, array< vector > mins, array< vector > maxs)
proto external void	AddRectsToUpdateQueue (array< vector > mins, array< vector > maxs)
proto external void	UpdateRectsFromQueue ()
proto external float	GetMaxTerrainResolution ()
event array< float >	GetExtents ()
event float	GenerateTerrain (array< vector > aShapeControlPoints, array< vector > aShapeTesselatedPoints, array< float > aShapeDistancesFromStart, array< int > aTesselatedToOriginalIndices, int heightMapXPos, int heightMapYPos, vector closestPointOnLineWP, vector genPointWS, float oldHeight, int tessPointAIdx, int tessPointBIdx, float ABRatio, float terrainInvScale, float signedDistFromSpline)
StaticModelEntityClass GenericEntityClass	CreateOccluders ()
proto external void	DestroyOccluders ()

Variables
VehiclePartPanelClass	m_fMaterialVariable = 0
	Read-only variable filled from code, used to animate material.

Detailed Description

Enumeration Type Documentation

EAddChildFlags [1/2]

enum EAddChildFlags

Enumerator
NONE
AUTO_TRANSFORM	Turn on AutoTransform on hierarchy component if present.
RECALC_LOCAL_TRANSFORM	Recalculate current world transform to local transform (child remains on the same world position).
MERGE_PHYSICS	Merge colliders into parent physics to enable collisions of child geometry.
NONE
AUTO_TRANSFORM	Turn on AutoTransform on hierarchy component if present.
RECALC_LOCAL_TRANSFORM	Recalculate current world transform to local transform (child remains on the same world position).
MERGE_PHYSICS	Merge colliders into parent physics to enable collisions of child geometry.

Definition at line 12 of file EAddChildFlags.c.

EAddChildFlags [2/2]

enum EAddChildFlags

Enumerator
NONE
AUTO_TRANSFORM	Turn on AutoTransform on hierarchy component if present.
RECALC_LOCAL_TRANSFORM	Recalculate current world transform to local transform (child remains on the same world position).
MERGE_PHYSICS	Merge colliders into parent physics to enable collisions of child geometry.
NONE
AUTO_TRANSFORM	Turn on AutoTransform on hierarchy component if present.
RECALC_LOCAL_TRANSFORM	Recalculate current world transform to local transform (child remains on the same world position).
MERGE_PHYSICS	Merge colliders into parent physics to enable collisions of child geometry.

Definition at line 12 of file EAddChildFlags.c.

EntityEvent [1/2]

enum EntityEvent

Various entity events.

Enumerator
TOUCH
INIT	Workshop is initializing data and any systems or UI elements should wait until ready.
VISIBLE
FRAME
POSTFRAME
ANIMEVENT	Animation system event.
SIMULATE
POSTSIMULATE
JOINTBREAK
PHYSICSMOVE
CONTACT
PHYSICSACTIVE
FIXEDFRAME
POSTFIXEDFRAME
USER3
USER4
USER5
DISABLED	General event switch. Workshop is disabled and any systems or UI elements should be also disabled - permanent state until application restart. Asset is disabled and should not load any data until until enabled. Disallowed by Platform - state could not be changed from the game. Killfeed is disabled. UI Widget is not enabled. Do not spawn this entity anywhere.
ALL	Everything except general switch.
TOUCH
INIT	Workshop is initializing data and any systems or UI elements should wait until ready.
VISIBLE
FRAME
POSTFRAME
ANIMEVENT	Animation system event.
SIMULATE
POSTSIMULATE
JOINTBREAK
PHYSICSMOVE
CONTACT
PHYSICSACTIVE
FIXEDFRAME
POSTFIXEDFRAME
USER3
USER4
USER5
DISABLED	General event switch. Workshop is disabled and any systems or UI elements should be also disabled - permanent state until application restart. Asset is disabled and should not load any data until until enabled. Disallowed by Platform - state could not be changed from the game. Killfeed is disabled. UI Widget is not enabled. Do not spawn this entity anywhere.
ALL	Everything except general switch.

Definition at line 13 of file EntityEvent.c.

EntityEvent [2/2]

enum EntityEvent

Enumerator
TOUCH
INIT	Workshop is initializing data and any systems or UI elements should wait until ready.
VISIBLE
FRAME
POSTFRAME
ANIMEVENT	Animation system event.
SIMULATE
POSTSIMULATE
JOINTBREAK
PHYSICSMOVE
CONTACT
PHYSICSACTIVE
FIXEDFRAME
POSTFIXEDFRAME
USER3
USER4
USER5
DISABLED	General event switch. Workshop is disabled and any systems or UI elements should be also disabled - permanent state until application restart. Asset is disabled and should not load any data until until enabled. Disallowed by Platform - state could not be changed from the game. Killfeed is disabled. UI Widget is not enabled. Do not spawn this entity anywhere.
ALL	Everything except general switch.
TOUCH
INIT	Workshop is initializing data and any systems or UI elements should wait until ready.
VISIBLE
FRAME
POSTFRAME
ANIMEVENT	Animation system event.
SIMULATE
POSTSIMULATE
JOINTBREAK
PHYSICSMOVE
CONTACT
PHYSICSACTIVE
FIXEDFRAME
POSTFIXEDFRAME
USER3
USER4
USER5
DISABLED	General event switch. Workshop is disabled and any systems or UI elements should be also disabled - permanent state until application restart. Asset is disabled and should not load any data until until enabled. Disallowed by Platform - state could not be changed from the game. Killfeed is disabled. UI Widget is not enabled. Do not spawn this entity anywhere.
ALL	Everything except general switch.

Definition at line 13 of file EntityEvent.c.

EntityFlags [1/2]

enum EntityFlags

Various entity flags.

Enumerator
VISIBLE	Entity is visible. Is rendered if there is some attached object and event EV_VISIBLE is invoked, when event mask is set.
TRACEABLE	Entity can be detected by various trace methods.
NO_LINK	Never link this entity into the scene.
FEATURE	Scene rendering hint for dominant objects that are not culled by standard way.
SET_RENDERED	You can check whether the entity has been rendered by enf::Entity::IsRendered().
STREAMABLE
ACTIVE	Tells that this entity has to be actively updated by engine. Job is currently actively processing its task. body is simulated
STATIC	Include entities with enf::EntityFlags.TFL_STATIC. Tells that this entity will represent mostly static object, so we can use more precise but slower methods for scene-tree linking.\ Also it tells to scene tree that he can count with this entity as tree-split hint.
USER1	Flags for custom usage and filterings.
USER2
USER3
USER4
USER5
NO_TREE	Do not include this entity into BSP tree building, because it's too huge, or off scene (like env-cube probes).
RELATIVE_Y	The Y coordinate stored in.
EDITOR_ONLY	Do not spawn this entity in game app.
DISABLED	Do not spawn this entity anywhere.
PROXY	Slave child entity, that is linked into scene tree just by its parent. Usually some small props/parts of more complex entity.
UPDATE_LINK	Set when entity has changed position, orientation or just have to relink its position in scene tree.
VISIBLE	Entity is visible. Is rendered if there is some attached object and event EV_VISIBLE is invoked, when event mask is set.
TRACEABLE	Entity can be detected by various trace methods.
NO_LINK	Never link this entity into the scene.
FEATURE	Scene rendering hint for dominant objects that are not culled by standard way.
SET_RENDERED	You can check whether the entity has been rendered by enf::Entity::IsRendered().
STREAMABLE
ACTIVE	Tells that this entity has to be actively updated by engine. Job is currently actively processing its task. body is simulated
STATIC	Include entities with enf::EntityFlags.TFL_STATIC. Tells that this entity will represent mostly static object, so we can use more precise but slower methods for scene-tree linking.\ Also it tells to scene tree that he can count with this entity as tree-split hint.
USER1	Flags for custom usage and filterings.
USER2
USER3
USER4
USER5
NO_TREE	Do not include this entity into BSP tree building, because it's too huge, or off scene (like env-cube probes).
RELATIVE_Y	The Y coordinate stored in.
EDITOR_ONLY	Do not spawn this entity in game app.
DISABLED	Do not spawn this entity anywhere.
PROXY	Slave child entity, that is linked into scene tree just by its parent. Usually some small props/parts of more complex entity.
UPDATE_LINK	Set when entity has changed position, orientation or just have to relink its position in scene tree.

Definition at line 13 of file EntityFlags.c.

EntityFlags [2/2]

enum EntityFlags

Enumerator
VISIBLE	Entity is visible. Is rendered if there is some attached object and event EV_VISIBLE is invoked, when event mask is set.
TRACEABLE	Entity can be detected by various trace methods.
NO_LINK	Never link this entity into the scene.
FEATURE	Scene rendering hint for dominant objects that are not culled by standard way.
SET_RENDERED	You can check whether the entity has been rendered by enf::Entity::IsRendered().
STREAMABLE
ACTIVE	Tells that this entity has to be actively updated by engine. Job is currently actively processing its task. body is simulated
STATIC	Include entities with enf::EntityFlags.TFL_STATIC. Tells that this entity will represent mostly static object, so we can use more precise but slower methods for scene-tree linking.\ Also it tells to scene tree that he can count with this entity as tree-split hint.
USER1	Flags for custom usage and filterings.
USER2
USER3
USER4
USER5
NO_TREE	Do not include this entity into BSP tree building, because it's too huge, or off scene (like env-cube probes).
RELATIVE_Y	The Y coordinate stored in.
EDITOR_ONLY	Do not spawn this entity in game app.
DISABLED	Do not spawn this entity anywhere.
PROXY	Slave child entity, that is linked into scene tree just by its parent. Usually some small props/parts of more complex entity.
UPDATE_LINK	Set when entity has changed position, orientation or just have to relink its position in scene tree.
VISIBLE	Entity is visible. Is rendered if there is some attached object and event EV_VISIBLE is invoked, when event mask is set.
TRACEABLE	Entity can be detected by various trace methods.
NO_LINK	Never link this entity into the scene.
FEATURE	Scene rendering hint for dominant objects that are not culled by standard way.
SET_RENDERED	You can check whether the entity has been rendered by enf::Entity::IsRendered().
STREAMABLE
ACTIVE	Tells that this entity has to be actively updated by engine. Job is currently actively processing its task. body is simulated
STATIC	Include entities with enf::EntityFlags.TFL_STATIC. Tells that this entity will represent mostly static object, so we can use more precise but slower methods for scene-tree linking.\ Also it tells to scene tree that he can count with this entity as tree-split hint.
USER1	Flags for custom usage and filterings.
USER2
USER3
USER4
USER5
NO_TREE	Do not include this entity into BSP tree building, because it's too huge, or off scene (like env-cube probes).
RELATIVE_Y	The Y coordinate stored in.
EDITOR_ONLY	Do not spawn this entity in game app.
DISABLED	Do not spawn this entity anywhere.
PROXY	Slave child entity, that is linked into scene tree just by its parent. Usually some small props/parts of more complex entity.
UPDATE_LINK	Set when entity has changed position, orientation or just have to relink its position in scene tree.

Definition at line 13 of file EntityFlags.c.

EntityVisualizerType [1/2]

enum EntityVisualizerType

Game editor entity visualizer type.

Enumerator
EVT_NONE	no visualizer
EVT_NORMAL	normal visualizer
EVT_SELECTED	selected entity visualizer (but no as main)
EVT_SELECTED_AS_MAIN	selected as main entity visualizer
EVT_UNDER_CURSOR	under cursor entity visualizer
EVT_NONE	no visualizer
EVT_NORMAL	normal visualizer
EVT_SELECTED	selected entity visualizer (but no as main)
EVT_SELECTED_AS_MAIN	selected as main entity visualizer
EVT_UNDER_CURSOR	under cursor entity visualizer

Definition at line 13 of file EntityVisualizerType.c.

EntityVisualizerType [2/2]

enum EntityVisualizerType

Enumerator
EVT_NONE	no visualizer
EVT_NORMAL	normal visualizer
EVT_SELECTED	selected entity visualizer (but no as main)
EVT_SELECTED_AS_MAIN	selected as main entity visualizer
EVT_UNDER_CURSOR	under cursor entity visualizer
EVT_NONE	no visualizer
EVT_NORMAL	normal visualizer
EVT_SELECTED	selected entity visualizer (but no as main)
EVT_SELECTED_AS_MAIN	selected as main entity visualizer
EVT_UNDER_CURSOR	under cursor entity visualizer

Definition at line 13 of file EntityVisualizerType.c.

PointChangedSituation [1/2]

enum PointChangedSituation

Enumerator
PCS_MOVED_FROM
PCS_MOVED_TO
PCS_ADDED
PCS_REMOVED
PCS_BEFORE_DATA_CHANGED
PCS_AFTER_DATA_CHANGED
PCS_BEFORE_TANGENT_CHANGED
PCS_AFTER_TANGENT_CHANGED
PCS_MOVED_FROM
PCS_MOVED_TO
PCS_ADDED
PCS_REMOVED
PCS_BEFORE_DATA_CHANGED
PCS_AFTER_DATA_CHANGED
PCS_BEFORE_TANGENT_CHANGED
PCS_AFTER_TANGENT_CHANGED

Definition at line 12 of file PointChangedSituation.c.

PointChangedSituation [2/2]

enum PointChangedSituation

Enumerator
PCS_MOVED_FROM
PCS_MOVED_TO
PCS_ADDED
PCS_REMOVED
PCS_BEFORE_DATA_CHANGED
PCS_AFTER_DATA_CHANGED
PCS_BEFORE_TANGENT_CHANGED
PCS_AFTER_TANGENT_CHANGED
PCS_MOVED_FROM
PCS_MOVED_TO
PCS_ADDED
PCS_REMOVED
PCS_BEFORE_DATA_CHANGED
PCS_AFTER_DATA_CHANGED
PCS_BEFORE_TANGENT_CHANGED
PCS_AFTER_TANGENT_CHANGED

Definition at line 12 of file PointChangedSituation.c.

Function Documentation

AddLightning()

proto external void AddLightning

(

WeatherLightning

lightning

)

AddPointData()

proto external void AddPointData	(	IEntitySource	entSrc,
		int	idx,
		ShapePointDataScriptBase	pointData )

AddRectsToUpdateQueue()

proto external void AddRectsToUpdateQueue	(	array< vector >	mins,
		array< vector >	maxs )

AffectFoliageCircle()

proto external void AffectFoliageCircle	(	vector	position,
		vector	velocity,
		float	height,
		float	diameter,
		float	strength = 1.0,
		float	falloffOffset = 0.5,
		bool	flatten = true,
		bool	sway = true )

Submit a circle obstacle in this frame.

Parameters

position	World coordinates of the obstacles bottom center
velocity	Obstacle velocity, world units / s
height	Obstacle height
diameter	Circle diameter
strength	Strength of the obstacle, [0, 1]
falloffOffset	Used to offset obstacle strength falloff, [0, 1]
flatten	Should flatten?
sway	Should sway?

AffectFoliageEllipse()

GenericTerrainEntityClass GenericEntityClass AffectFoliageEllipse	(	vector	position,
		vector	velocity,
		float	height,
		float	sizeX,
		float	sizeZ,
		float	maskOffset,
		float	angleRAD,
		float	strength = 1.0,
		float	falloffOffset = 0.5,
		bool	flatten = true,
		bool	sway = true )

Submit an ellipse obstacle in this frame.

Parameters

position	World coordinates of the obstacles bottom center
velocity	Obstacle velocity, world units / s
height	Obstacle height
sizeX	Size in the X direction
sizeZ	Size in the Z direction
maskOffset	Offset of the obstacle in the Z direction, [-1, 1]
angleRAD	Obstacle rotation around the Y axis, radians, clockwise
strength	Strength of the obstacle, [0, 1]
falloffOffset	Used to offset obstacle strength falloff, [0, 1]
flatten	Should flatten?
sway	Should sway?

AffectFoliageRect()

proto external void AffectFoliageRect	(	vector	position,
		vector	velocity,
		float	height,
		float	sizeX,
		float	sizeZ,
		float	maskOffset,
		float	angleRAD,
		float	strength = 1.0,
		float	falloffOffset = 0.5,
		bool	flatten = true,
		bool	sway = true )

Submit a rectangle obstacle in this frame.

Parameters

position	World coordinates of the obstacles bottom center
velocity	Obstacle velocity, world units / s
height	Obstacle height
sizeX	Size in the X direction
sizeZ	Size in the Z direction
maskOffset	Offset of the obstacle in the Z direction, [-1, 1]
angleRAD	Obstacle rotation around the Y axis, radians, clockwise
strength	Strength of the obstacle, [0, 1]
falloffOffset	Used to offset obstacle strength falloff, [0, 1]
flatten	Should flatten?
sway	Should sway?

AffectFoliageSquare()

proto external void AffectFoliageSquare	(	vector	position,
		vector	velocity,
		float	height,
		float	size,
		float	angleRAD,
		float	strength = 1.0,
		float	falloffOffset = 0.5,
		bool	flatten = true,
		bool	sway = true )

Submit a square obstacle in this frame.

Parameters

position	World coordinates of the obstacles bottom center
velocity	Obstacle velocity, world units / s
height	Obstacle height
size	Size of the box
angleRAD	Obstacle rotation around the Y axis, radians, clockwise
strength	Strength of the obstacle, [0, 1]
falloffOffset	Used to offset obstacle strength falloff, [0, 1]
flatten	Should flatten?
sway	Should sway?

AttachCameraToEntity()

proto external void AttachCameraToEntity	(	IEntity	ent,
		int	pivotIndex,
		vector	positionOffset,
		vector	anglesOffset )

BeforeShapeTransform()

proto external void BeforeShapeTransform	(	IEntitySource	shapeEntitySrc,
		ShapeEntity	shapeEntity,
		inout vector	oldTransform[4] )

Called when parent shape's transform (coords, angles, scale) changes Handles calling either script or c++ implementation of BeforeShapeTransformInternal

BeforeShapeTransformInternal()

void BeforeShapeTransformInternal ( IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, inout vector oldTransform[4] )

protected

Implementation of what should happen before transform (coords, angles, scale) of shape changes Exists because some generators do not care whether their parent shape moved while others do (transform change does not invoke init). Called from BeforeShapeTransform. Should not be called directly.

CalculateInterirorAt()

proto void CalculateInterirorAt	(	vector	pos,
		InteriorRequestCallback	callback )

CanAnchorSnap()

proto external bool CanAnchorSnap	(	IEntitySource	shapeEntitySrc,
		int	parentAnchor,
		IEntitySource	other,
		int	otherAnchor,
		bool	isReciever )

Called when anchor snapping is attempted Handles calling either script or c++ implementation of CanAnchorSnapInternal

CanAnchorSnapInternal()

bool CanAnchorSnapInternal ( IEntitySource shapeEntitySrc, int parentAnchor, IEntitySource other, int otherAnchor, bool isReciever )

protected

Implementation of whether this generator allows snapping of given two anchors

See also

OnAnchorSnappedInternal

Returns

False if parentAnchor from shapeEntitySrc and otherAnchor from other should not be snapped, true otherwise

CheckValidDate()

proto external bool CheckValidDate	(	int	year,
		int	month,
		int	day )

Checks if date is valid (checks for leap years and correct day of the month)

Parameters

year	Year
month	Month (in 1-12 range)
day	Day (in 1-31 range)

Returns

Returns true when date is valid, false otherwise.

ClearLightFlags()

proto external int ClearLightFlags

(

LightFlags

flags

)

Clear light flags

Parameters

flags

flags to be cleared

Returns

currently set flags

CreateLight()

LightEntityClass GenericEntityClass CreateLight	(	LightType	type,
		LightFlags	flags,
		float	radius,
		Color	color,
		float	LV,
		vector	position,
		vector	direction = vector.Forward )

Use LightEntity::CreateLight instead of spawning LightEntity via Game::SpawnEntity for the creation of light in a script. If you spawn this entity with a prefab, all parameters sets will be automatically applied. This should be used over LightHandle unless you want a low-level API.

Create new static light by type

Parameters

type	Type of light
flags	Creation flags.
radius	Radius
color	Color in RGB form
LV	LV value of a light, final light color is combined from color and LV properties (color * LV^2)
position	Position of the entity in world coordinates
direction	Direction of spot-vector (used for spotlights)

Returns

LightEntity

CreateOccluders()

StaticModelEntityClass GenericEntityClass CreateOccluders

(

)

DestroyOccluders()

proto external void DestroyOccluders

(

)

DetachCamera()

proto external void DetachCamera

(

)

DisableUserEV()

proto external void DisableUserEV

(

)

Disable user EV and use automatic

EnableUserEV()

proto external void EnableUserEV	(	float	EV,
		bool	absolute )

Set user EV applied for both lighting parts, dynamically applied when rendering

Parameters

EV	new probe EV in range <-20, 20>
absolute	if the EV value is absolute (aka LV) or relative to global ambient (sky)

EnableVolume()

proto external void EnableVolume	(	int	index,
		bool	On )

enable volume

Parameters

index
On	true = switch it on, false = switch it off

ForceTemperatureTableRecompute()

proto external bool ForceTemperatureTableRecompute

(

)

Forces complete recomputation of temperature table based on current min/max temperatures and sun irradiance. This needs to be called if you change some min/max temperature settings and want to immediately change temperatures of all objects based on these settings. Beware! This is performance heavy so use only when really needed (for example when changing temperature settings and you want to see immediate effect of the changes).

GenerateTerrain()

event float GenerateTerrain	(	array< vector >	aShapeControlPoints,
		array< vector >	aShapeTesselatedPoints,
		array< float >	aShapeDistancesFromStart,
		array< int >	aTesselatedToOriginalIndices,
		int	heightMapXPos,
		int	heightMapYPos,
		vector	closestPointOnLineWP,
		vector	genPointWS,
		float	oldHeight,
		int	tessPointAIdx,
		int	tessPointBIdx,
		float	ABRatio,
		float	terrainInvScale,
		float	signedDistFromSpline )

GenerateTesselatedShape()

proto external void GenerateTesselatedShape

(

notnull array< vector >

outPoints

)

GetAllInfluenceBBoxes()

proto void GetAllInfluenceBBoxes	(	IEntitySource	shapeEntitySrc,
		out notnull array< vector >	mins,
		out notnull array< vector >	maxes )

Returns bboxes for all segments of this shape Similar to GeneratorBaseEntity events, ith bbox is given by mins[i] and maxes[i]. Since the bboxes are done by parts their sum may be smaller than the bbox of the whole entity. The bboxes returned may overlap.

GetCentralPolyline()

proto bool GetCentralPolyline	(	out notnull array< vector >	dstPositions,
		out notnull array< float >	dstWidths,
		float	precision = 0.1 )

Computes the central polyline (an approximation of the parent spline in world space) and the river width at its points.

Parameters

dstPositions	Output array for the resulting central points. NOTE: Any existing content will be removed.
dstWidths	Output array for the resulting widths (will have the same size as dstPositions). NOTE: Any existing content will be removed.
precision	Maximum allowed distance between the polyline approximation and the original spline. Higher values yield lower precision and fewer points. The default value matches the one used in generating the actual river mesh.

Returns

Returns true on success, or false if the parent spline has fewer than two points.

GetChannel()

proto external BaseChatChannel GetChannel

(

int

channelId

)

Parameters

[channelId]

Channel ID indexed from 0.

Returns

Channel or null if ID is invalid

GetChannelName()

proto external string GetChannelName

(

int

channelId

)

Parameters

[channelId]

Defined by BaseChatEntity. Indexed from 0.

Returns

Name of channel as defined in BaseChatEntity

GetChannelsCount()

BaseChatEntityClass GenericEntityClass GetChannelsCount

(

)

Returns

Total number of channels

GetConeAngle()

proto external float GetConeAngle

(

)

Returns the current cone angle in degrees (useful for LightType.SPOT only).

GetCurrentLatitude()

proto external float GetCurrentLatitude

(

)

Returns current latitude.

GetCurrentLongitude()

proto external float GetCurrentLongitude

(

)

Returns current longitude.

GetCurrentSunMoonDirAndPhase()

proto void GetCurrentSunMoonDirAndPhase	(	out vector	outSunDir,
		out vector	outMoonDir,
		out float	outMoonPhase01 )

Retrieve current sun direction, moon direction and moon phase.

Parameters

outSunDir	Current sun direction
outMoonDir	Current moon direction
outMoonPhase01	Moon phase (0 = new moon, 1 = full moon)

GetCurrentWaterAccumulationCracks()

proto external float GetCurrentWaterAccumulationCracks

(

)

GetCurrentWaterAccumulationPuddles()

proto external float GetCurrentWaterAccumulationPuddles

(

)

GetCurrentWeatherState()

BaseWeatherManagerEntityClass GenericEntityClass GetCurrentWeatherState

(

)

GetCurrentWetness()

proto external float GetCurrentWetness

(

)

GetDate()

proto void GetDate	(	out int	year,
		out int	month,
		out int	day )

Retrieves the current date (Year, Month in 1-12 range, Day in 1-31 range).

GetDay()

proto external int GetDay

(

)

Returns current in-game day of the month (Range 1-31)

GetDayDuration()

proto external float GetDayDuration

(

)

Retrieves in-game day duration as realtime seconds.

Returns

Returns the duration of one in-game day as realtime seconds.

GetDayInYear()

proto external int GetDayInYear

(

)

Returns the in-game day

GetDefaultChannel()

proto external BaseChatChannel GetDefaultChannel

(

)

Returns

Returns the channel which was setup as default

GetDSTOffset()

proto external float GetDSTOffset

(

)

Gets DST offset (in hours)

GetEngineTime()

proto external float GetEngineTime

(

)

Retrieves the current engine time (synchronized between clients), this value is not affected by time multiplier nor automatic time advancement attributes.

GetExistingInstances()

RiverEntityClass GeneratorBaseEntityClass GetExistingInstances

(

out notnull array< RiverEntity >

instances

)

Entity for a single river.

Must have a shape entity as a parent - central points are taken from the parent.

Gets all existing RiverEntity instances (across all loaded worlds).

Parameters

instances

Where the instance pointers will be added.

GetExtents()

event array< float > GetExtents

(

)

GetFogAmount()

proto external float GetFogAmount

(

)

GetFogHeightDensity()

proto external float GetFogHeightDensity

(

)

GetHoursMinutesSeconds()

proto void GetHoursMinutesSeconds	(	out int	hours,
		out int	minutes,
		out int	seconds )

Retrieves the current time of the day. Example:

SetTimeOfTheDay(16.5);
int h, m, s;
GetHoursMinutesSeconds(h, m, s);
Print(h);
Print(m);
Print(s);
 
>> int h = 16
>> int m = 30
>> int s = 00

GetInfluenceBBoxesInSegments()

proto void GetInfluenceBBoxesInSegments	(	IEntitySource	shapeEntitySrc,
		int	firstIncl,
		int	lastIncl,
		out notnull array< vector >	mins,
		out notnull array< vector >	maxes )

Returns bboxes for segments of this shape within index range Similar to GeneratorBaseEntity events, ith bbox is given by mins[i] and maxes[i]. Since the bboxes are done by parts their sum may be smaller than the bbox of the whole entity. The bboxes returned may overlap. The range is including the first and last index.

GetIsDayAutoAdvanced()

proto external bool GetIsDayAutoAdvanced

(

)

Retrieves whether automatic time advancement is enabled or not.

Returns

Returns true if daytime is advaned automatically, false otherwise.

GetMapValuesAdvAtPos()

proto void GetMapValuesAdvAtPos	(	vector	pos,
		out float	river,
		out float	riverSlope,
		out float	lake,
		out float	coast )

GetMapValuesAtPos()

SoundWorldClass GenericEntityClass GetMapValuesAtPos	(	vector	pos,
		out float	sea,
		out float	forest,
		out float	city,
		out float	meadow )

GetMaxTerrainResolution()

proto external float GetMaxTerrainResolution

(

)

GetMonth()

proto external int GetMonth

(

)

Returns current in-game month of the year (Range 1-12)

GetMoonPhase()

proto external float GetMoonPhase

(

float

timeOfTheDay24

)

Gets moon phase for supplied time of the day.

Returns

phase in <0...1> range. 0 = new moon, 1 = full moon

GetMoonPhaseForDate()

proto float GetMoonPhaseForDate	(	int	year,
		int	month,
		int	day,
		float	timeOfTheDay24,
		float	timezone,
		float	dstOffset )

Gets moon phase for supplied date, geo location is not needed but timezone yes in order to calculate UTC correctly.

Parameters

year	Year.
month	Month in range <1, 12>
day	Day in range <1, 31>
timeOfTheDay24	Time of the day in 24 hour floating point format.
timezone	TimeZone Offset in hours ranging <-12, +14>
dstOffset	DST (daylight savings time) offset, must be 0.0 or positive value.

Returns

phase in <0...1> range. 0 = new moon, 1 = full moon

GetNearPlane()

proto external float GetNearPlane

(

)

Returns the current near plane of the light in meters.

GetOrCreateRegionalDestructionManager()

DestructionManagerClass GenericEntityClass GetOrCreateRegionalDestructionManager

(

const vector

position

)

GetOutlinePoints()

proto void GetOutlinePoints	(	out notnull array< vector >	dst,
		float	precision = 0.1 )

Computes the river's outline points (in world space).

Parameters

dst	Output array for the resulting points (left-side and right-side alternating). NOTE: Any existing content will be removed.
precision	Higher values result in lower precision and fewer points. The default value matches the one used to generate the actual river mesh. Details: First, the spline is approximated by a polyline, which is then stroked to generate the outline. This value specifies the maximum allowed distance between the polyline and the original spline.

GetOverrideSunIrradiance()

proto external bool GetOverrideSunIrradiance

(

)

Gets if Sun irradience override is enabled

GetOverrideTemperature()

proto external bool GetOverrideTemperature

(

)

Gets if temperature override is enabled

GetPointContainerOfType()

ShapeEntityClass GenericEntityClass GetPointContainerOfType	(	IEntitySource	src,
		int	anchorIdx,
		string	type )

GetPointCount()

proto external int GetPointCount

(

)

GetPointsPositions()

proto external void GetPointsPositions

(

notnull array< vector >

outPoints

)

Copies positions of points to given array.

GetRadius()

proto external float GetRadius

(

)

Returns the current radius of the light in meters.

Get radius of the area. To be overloaded by inherited classes.

Returns

Radius

Definition at line 21 of file SCR_CampaignBuildingAreaMeshComponent.c.

GetRainIntensity()

proto external float GetRainIntensity

(

)

GetRplComponent()

proto external RplComponent GetRplComponent

(

)

Returns the replication component associated to this entity.

Returns

Definition at line 188 of file SCR_RespawnComponent.c.

GetSegmentBoundBoxes()

SplineTerrainGeneratorEntityBaseClass GeneratorBaseEntityClass GetSegmentBoundBoxes	(	inout notnull array< vector >	mins,
		inout notnull array< vector >	maxs )

GetSignalIndex()

proto external int GetSignalIndex

(

string

name

)

Get index for signal name. Return -1 if signal not found.

GetSkyMaterial()

proto external ref Material GetSkyMaterial

(

)

GetStyle()

proto external BaseChatChannelStyle GetStyle

(

)

Returns

Base channel style object.

GetSunIrradianceMaxOverride()

proto external float GetSunIrradianceMaxOverride

(

)

Gets value for Sun Irradiance Max override. Value represents maximal Sun irradiance during the day

GetSunIrradianceMinOverride()

proto external float GetSunIrradianceMinOverride

(

)

Gets value for Sun Irradiance Min override. Value represents minimal Sun irradiance during the day

GetSunriseHour()

proto bool GetSunriseHour

(

out float

hour24

)

Gets sunrise hour in 24 hour format e.g. 12.50 is 12:30 A.M

Returns

True if there is a valid sunrise with current latitude/longitude/date configuration, false otherwise

GetSunriseHourForDate()

proto bool GetSunriseHourForDate	(	int	year,
		int	month,
		int	day,
		float	latitude,
		float	longitude,
		float	timezone,
		float	dstOffset,
		out float	hour24 )

Gets sunrise hour in 24 hour format e.g. 12.50 is 12:30 A.M. For specific date, geolocation, timezone and DST.

Parameters

year	Year.
month	Month in range <1, 12>
day	Day in range <1, 31>
latitude	Latitude in range <-90, 90> where +90 equals north pole, 0 equator and -90.0 south pole
longitude	Longitude in range <-180.0, 180.0> where 0 equals (almost) greenwich meridian.
timezone	TimeZone Offset in hours ranging <-12, +14>
dstOffset	DST (daylight savings time) offset, must be 0.0 or positive value.

Returns

True if there is a valid sunrise with current latitude/longitude/date configuration, false otherwise

GetSunsetHour()

proto bool GetSunsetHour

(

out float

hour24

)

Gets sunset hour in 24 hour format e.g. 12.50 is 12:30 A.M

Returns

True if there is a valid sunset with current latitude/longitude/date configuration, false otherwise

GetSunsetHourForDate()

proto bool GetSunsetHourForDate	(	int	year,
		int	month,
		int	day,
		float	latitude,
		float	longitude,
		float	timezone,
		float	dstOffset,
		out float	hour24 )

Gets sunset hour in 24 hour format e.g. 12.50 is 12:30 A.M for specific date.

Returns

True if there is a valid sunset with current latitude/longitude/date configuration, false otherwise

GetTangents()

proto void GetTangents	(	int	pointIdx,
		out vector	inTangent,
		out vector	outTangent )

Returns tangents at given anchor point For point i the inTangent is a tangent between points i - 1 and i at point i. The outTangent is a tangent between points i and i + 1 at point i.

GetTemperatureAirMaxOverride()

proto external float GetTemperatureAirMaxOverride

(

)

Gets value for Temperature Air Max override (in degrees Celsius). Value represents maximal air temperature during the day

GetTemperatureAirMinOverride()

proto external float GetTemperatureAirMinOverride

(

)

Gets value for Temperature Air Min override (in degrees Celsius). Value represents minimal air temperature during the day

GetTemperatureSkyMaxOverride()

proto external float GetTemperatureSkyMaxOverride

(

)

Gets value for Temperature Sky Max override (in degrees Celsius). Value represents maximal sky temperature during the day

GetTemperatureSkyMinOverride()

proto external float GetTemperatureSkyMinOverride

(

)

Gets value for Temperature Sky Min override (in degrees Celsius). Value represents minimal sky temperature during the day

GetTemperatureWaterMaxOverride()

proto external float GetTemperatureWaterMaxOverride

(

)

Gets value for Temperature Water Max override (in degrees Celsius). Value represents maximal water temperature during the day

GetTemperatureWaterMinOverride()

proto external float GetTemperatureWaterMinOverride

(

)

Gets value for Temperature Water Min override (in degrees Celsius). Value represents minimal water temperature during the day

GetTerrain()

GenericWorldEntityClass GenericEntityClass GetTerrain	(	float	x,
		float	z )

Get terrain

GetTerrainBoundBox()

proto external void GetTerrainBoundBox	(	out vector	mins,
		out vector	maxs )

Gets terrain bounding box in world coordinates.

GetTileNumber()

proto external int GetTileNumber	(	int	terrx,
		int	terry )

Get linear tile number from texture coordinates.

Parameters

terrx	x terrain coords
terry	y terrain coords

Returns

tile number in linear pos

GetTileSizeTC()

proto external int GetTileSizeTC

(

)

Return number of vertices in tile.

GetTileTextureResName()

proto bool GetTileTextureResName	(	int	tile,
		out ResourceName	textureResName )

GetTileVerticesCount()

proto external int GetTileVerticesCount

(

)

GetTimeOfTheDay()

proto external float GetTimeOfTheDay

(

)

Retrieves the current time of the day.

Returns

Time fraction in hours <0.0, 24.0> Example:

SetTimeOfTheDay(16.5);
float totd = GetTimeOfTheDay();
Print(totd);
 
>> float totd = 16.5

GetTimeZoneOffset()

proto external float GetTimeZoneOffset

(

)

Returns time zone offset (in hours)

GetTransceiversInRange()

RadioManagerEntityClass GenericEntityClass GetTransceiversInRange	(	vector	position,
		float	range,
		out notnull array< BaseTransceiver >	tsvList )

Gets all transceivers in given range that are in power ON state.

Parameters

[in]	range	Range in meters
[out]	tsvList	Fresh list of BaseTransceivers in range

Returns

Number of BaseTransceivers returned

GetTransitionManager()

proto BaseWeatherStateTransitionManager GetTransitionManager

(

)

Get weather state transition manager

Returns

Transition manager, null if client is not master.

GetUserEV()

proto external float GetUserEV

(

float

EV

)

Get user EV from probe actual setting

GetVolumeIndex()

proto external int GetVolumeIndex

(

string

volumeName

)

Get index of volume according the given name, negative value if it doesn't exist

Parameters

volumeName

GetVolumeName()

proto external string GetVolumeName

(

int

index

)

Get name of volume according the given index, empty string if it doesn't exist

Parameters

index

GetVolumesCount()

proto external int GetVolumesCount

(

)

Get number of probe's volumes

GetWeatherStatesList()

proto external void GetWeatherStatesList

(

out notnull array< ref WeatherState >

outStates

)

Gets all Weather States.

GetWeekDay()

proto external int GetWeekDay

(

)

Returns current in-game week day in range [0-6], starts at Monday=0.

Returns

positive integer 0-6 representing each day of the week, starting at Monday. -1 if current date is invalid.

GetWeekDayForDate()

proto external int GetWeekDayForDate	(	int	year,
		int	month,
		int	day )

Returns week day in range [0-6], starts at Monday=0, for the supplied date.

Returns

positive integer 0-6 representing each day of the week, starting at Monday. -1 if supplied date is invalid.

Parameters

year	Year.
month	Month in range <1, 12>
day	Day in range <1, 31>

GetWhisperChannel()

proto external PrivateMessageChannel GetWhisperChannel

(

)

Returns

Channel or null if no whisper channel is configured

GetWindDirection()

proto external float GetWindDirection

(

)

Retrieves in-game wind direction angle in degrees.

Returns

Returns the in-game wind direction angle in degrees <0, 360.0>

GetWindSpeed()

proto external float GetWindSpeed

(

)

Retrieves in-game wind speed in meters per second.

Returns

Returns the in-game wind speed in meters per second.

GetYear()

proto external int GetYear

(

)

Returns current in-game year

HasPointExplicitTangents()

SplineShapeEntityClass ShapeEntityClass HasPointExplicitTangents

(

int

pointIdx

)

Returns true if tangents at given anchor point were explicitly set by user, false if they are computed automatically.

IsCastShadow()

proto external bool IsCastShadow

(

)

Returns true if the light is casting shadows.

IsClosed()

proto external bool IsClosed

(

)

IsDSTEnabled()

proto external bool IsDSTEnabled

(

)

Retrieves whether DST (daylight savings time) is enabled.

IsDynamic()

proto external bool IsDynamic

(

)

Returns true if the light is dynamic, false otherwise.

IsEnabled()

proto external bool IsEnabled

(

)

Returns true if the light is enabled.

Check if the component is enabled.

Returns

True when enabled

Definition at line 239 of file SCR_BaseManualCameraComponent.c.

Isfinished()

proto external bool Isfinished

(

)

IsFogAmountOverridden()

proto external bool IsFogAmountOverridden

(

)

IsFogHeightDensityOverridden()

proto external bool IsFogHeightDensityOverridden

(

)

IsLightFlagsSet()

proto external bool IsLightFlagsSet

(

LightFlags

flags

)

Returns true if the flags is set.

IsPlaying()

proto external bool IsPlaying

(

)

IsRainIntensityOverridden()

proto external bool IsRainIntensityOverridden

(

)

IsVolumeEnabled()

proto external bool IsVolumeEnabled

(

int

index

)

Is volume enabled ?

Parameters

index

IsWindDirectionOverridden()

proto external bool IsWindDirectionOverridden

(

)

IsWindSpeedOverridden()

proto external bool IsWindSpeedOverridden

(

)

MuteCategory()

proto external void MuteCategory	(	MusicCategory	musicCategory,
		bool	mute,
		bool	stopNow )

(Un)Mutes a category locally. Does not influence any categories muted from server side

OnAnchorSnapped()

proto external void OnAnchorSnapped	(	IEntitySource	shapeEntitySrc,
		int	parentAnchor,
		IEntitySource	other,
		int	otherAnchor,
		bool	isReciever )

Called when anchor snapping happend, either a parent's anchor snapped to something or something to a parent's anchor Handles calling either script or c++ implementation of OnAnchorSnappedInternal

OnAnchorSnappedInternal()

void OnAnchorSnappedInternal ( IEntitySource shapeEntitySrc, int parentAnchor, IEntitySource other, int otherAnchor, bool isReciever )

protected

Implementation of what should happen when anchor snapping happens Called from OnShapeChanged. Should not be called directly.

Parameters

shapeEntitySrc	Parent of this generator
parentAnchor	Anchor on parent which snapped
other	Other shape taking part in snapping
otherAnchor	Anchor index on the other entity
isReciever	True if parent of this generator did not move during snapping - something else snapped to it, false otherwise

OnIntersectingShapeChangedXZ()

proto external void OnIntersectingShapeChangedXZ	(	IEntitySource	shapeEntitySrc,
		IEntitySource	other,
		array< vector >	mins,
		array< vector >	maxes )

Called when a shape intersecting our bbox changed or moved out Handles calling either script or c++ implementation of OnIntersectingShapeChangedXZInternal

OnIntersectingShapeChangedXZInternal()

void OnIntersectingShapeChangedXZInternal ( IEntitySource shapeEntitySrc, IEntitySource other, array< vector > mins, array< vector > maxes )

protected

Implementation for event emitted when a part of shape which is inside the generator's parent shape bounding box changes. The scope of which parts of the other shape changed (which also intersect or stopped intersecting our shape's bbox) is given by bounding boxes (in world space) provided in mins and maxes arrays. For each i: mins[i] and maxes[i] form a bounding box. The intersection is tested only in the XZ axis (when looking from above), e.g. other may be high above shapeEntitySrc and this event will still be triggered.

Parameters

shapeEntitySrc	Parent of this generator
other	The intersecting shape
mins	Minimum values of bounding boxes
maxes	Maximum values of bounding boxes

OnLoad()

event bool OnLoad

(

notnull ScriptBitReader

reader

)

Definition at line 21 of file RegionalDestructionManager.c.

OnPointChanged()

proto external void OnPointChanged	(	IEntitySource	src,
		ShapeEntity	shapeEntity,
		PointChangedSituation	situation,
		int	pointIndex,
		vector	position )

Called when a point was changed. OnShapeChanged is also called in that case.

OnPointChangedInternal()

void OnPointChangedInternal ( IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, PointChangedSituation situation, int pointIndex, vector position )

protected

Specific implementation for given generator which can directly react to changes in points. Workbench API functions may be called from here, do NOT wrap them in begin/end entity edit. Called from OnPointChanged. Should not be called directly.

Parameters

situation	Enum int, 0 = moved_from position, 1 = moved_to position, 2 = added point at position, 3 = removed point from position.
pointIndex	Index of the point on which the property was changed.
position	vector in LS at which the situation happened.

OnPointDataChanged()

proto external void OnPointDataChanged	(	IEntitySource	src,
		ShapeEntity	shapeEntity,
		PointChangedSituation	situation,
		string	propertyID,
		array< int >	pointIndices )

Called when PointData on one of the points has been changed. OnShapeChanged is also called in that case.

OnPointDataChangedInternal()

void OnPointDataChangedInternal ( IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, PointChangedSituation situation, string propertyID, array< int > pointIndices )

protected

Specific implementation for given generator which can directly react to changes in point data. Workbench API functions may be called from here, do NOT wrap them in begin/end entity edit. Called from OnPointDataChanged. Should not be called directly.

Parameters

situation	Enum int, 2 = point data were added, 4 = before point data is changed, 5 = after point data is changed.
propertyID	Name of the property that was changed
pointIndices	Indices of points on which the properties were changed.

OnSave()

RegionalDestructionManagerClass GenericEntityClass OnSave

(

notnull ScriptBitWriter

writer

)

Definition at line 1 of file RegionalDestructionManager.c.

OnShapeChanged()

proto external void OnShapeChanged	(	IEntitySource	shapeEntitySrc,
		ShapeEntity	shapeEntity,
		array< vector >	mins,
		array< vector >	maxes )

Called when parent shape is changed in any way (except for cases handled by OnShapeTransform and OnShapeInit) Handles calling either script or c++ implementation of OnShapeWBInitInternal

OnShapeChangedInternal()

void OnShapeChangedInternal ( IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, array< vector > mins, array< vector > maxes )

protected

Specific implementation for given generator which handles what should happen when shape changes Workbench API functions may be called from here, do NOT wrap them in begin/end entity edit. Called from OnShapeChanged. Should not be called directly.

Bounding boxes (in world space) of areas where was the parent shape potentially changed are provided in mins and maxes arrays. For each i mins[i] and maxes[i] form a bounding box.

Parameters

shapeEntitySrc	Parent of this generator
shapeEntity	Parent of this generator
mins	Minimum values of bounding boxes
maxes	Maximum values of bounding boxes

OnShapeInit()

GeneratorBaseEntityClass GenericEntityClass OnShapeInit	(	IEntitySource	shapeEntitySrc,
		ShapeEntity	shapeEntity )

Called when parent shape is first initialized - called only once Handles calling either script or c++ implementation of OnShapeInitInternal

OnShapeInitInternal()

void OnShapeInitInternal ( IEntitySource shapeEntitySrc, ShapeEntity shapeEntity )

protected

Specific implementation for given generator which handles what should happen when shape is initialized for the first time Do NOT call Workbench API functions from here. Called from OnShapeInit. Should not be called directly.

OnShapeTransform()

proto external void OnShapeTransform	(	IEntitySource	shapeEntitySrc,
		ShapeEntity	shapeEntity,
		array< vector >	mins,
		array< vector >	maxes )

Called when parent shape's transform (coords, angles, scale) changes Handles calling either script or c++ implementation of OnShapeTransformInternal

OnShapeTransformInternal()

void OnShapeTransformInternal ( IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, array< vector > mins, array< vector > maxes )

protected

Implementation of what should happen when transform (coords, angles, scale) of shape changes Exists because some generators do not care whether their parent shape moved while others do (transform change does not invoke init). Called from OnShapeTransform. Should not be called directly.

Pause()

proto external void Pause

(

)

Play() [1/2]

CinematicEntityClass GenericEntityClass Play

(

)

Start playing the animation. Call 'Prepare' first if you need to change the setup of a component!

Definition at line 85 of file SCR_AudioSource.c.

Play() [2/2]

MusicManagerClass GenericEntityClass Play

(

string

musicName

)

'Forces' a sound to play without taking into account the automated evaluation process

PlayCameraAnimation()

proto external void PlayCameraAnimation	(	ResourceName	animFile,
		string	boneName,
		float	startTimeOffset )

PlayCameraAnimationExt()

proto external void PlayCameraAnimationExt	(	ResourceName	animFile,
		string	boneName,
		float	startTimeOffset,
		vector	upVec,
		vector	asideVec )

QueueDestructionHeatmapEntry()

proto external void QueueDestructionHeatmapEntry

(

notnull DestructionHeatmapEntry

entryData

)

Recapture()

proto external void Recapture

(

)

capture probe

RegisterGenerator()

proto external void RegisterGenerator	(	vector	bbMin,
		vector	bbMax,
		int	priority )

RemoveGenerator()

proto external void RemoveGenerator	(	bool	forceUpdate,
		array< vector >	mins,
		array< vector >	maxs )

RequestServerMuteCategory()

proto external void RequestServerMuteCategory	(	MusicCategory	musicCategory,
		bool	mute )

Requests server (from any client) to mute a category on the server, this muted category is seperated from your own (locally) muted categories.

ServerIsCategoryMuted()

proto external bool ServerIsCategoryMuted

(

MusicCategory

musicCategory

)

Checks whether a given category is muted by the server (game master).

SetCastShadow()

proto external void SetCastShadow

(

bool

enable

)

SetColor()

proto external void SetColor	(	Color	color,
		float	LV )

Set light's new color

Parameters

color	color of a light
LV	LV value of a light, final light color is combined from color and LV properties (color * LV^2)

SetConeAngle()

proto external void SetConeAngle

(

float

angle

)

Sets light cone angle in degrees (useful for LightType.SPOT only)

SetConeAngleAttenuation()

proto external void SetConeAngleAttenuation

(

float

coneAngleAttenuation

)

Sets light cone angle attenuation (SPOT)

Parameters

coneAngleAttenuation

<0..1> value, where 0 = full angle attenuation, 1 = no angle attenuation

SetCurrentLatitude()

proto external bool SetCurrentLatitude

(

float

latitude

)

Sets latitude as <-90, +90>. Can only be set by the authority (server, singleplayer...)

Returns

Returns true when command is authorized, false otherwise.

SetCurrentLongitude()

proto external bool SetCurrentLongitude

(

float

longitude

)

Sets longitude as <-180, +180>. Can only be set by the authority (server, singleplayer...)

Returns

Returns true when command is authorized, false otherwise.

SetCurrentWaterAccumulation()

proto external bool SetCurrentWaterAccumulation	(	float	waterAccumulationCracks,
		float	waterAccumulationPuddles )

SetCurrentWetness()

proto external bool SetCurrentWetness

(

float

wetness

)

SetDate()

proto external bool SetDate	(	int	year,
		int	month,
		int	day,
		bool	immediateChange = false )

Sets the current in-game date (year/month/day). Only issuable by the authority. Automatically broadcast to all clients. You may check date validity prior to this call with CheckValidDate method.

Parameters

year	Year
month	Month (in 1-12 range)
day	Day (in 1-31 range)
immediateChange	Whether change should be applied immediately, forcing recomputation. This should be true only in case of editor and similar items.

Returns

Returns true when command is issued successfully and date is VALID, false otherwise.

SetDayDuration()

proto external bool SetDayDuration

(

float

realtimeSeconds

)

Sets in-game day duration as realtime seconds. Only issuable by the authority. Automatically broadcast to all clients.

Parameters

realtimeSeconds

Seconds in real time one ingame day will take.

Returns

Returns true when command is issued successfully, false otherwise.

SetDiffuseEV()

proto external void SetDiffuseEV

(

float

EV

)

Set EV for difuse part, this changes the probe definition part

Parameters

EV	0 is original probe value

SetDistanceAtt()

proto external void SetDistanceAtt

(

float

att

)

Set light distance attenuation -> power function, default is 2 corresponding to light without any other internal reflector

Parameters

att	attenuation

SetDSTEnabled()

proto external bool SetDSTEnabled

(

bool

enabled

)

Sets whether DST (daylight savings time) is enabled or disabled.

SetDSTOffset()

proto external bool SetDSTOffset

(

float

dstOffsetHours

)

Sets DST Offset (in hours). Can only be set by authority.

SetEnabled()

proto external void SetEnabled

(

bool

enabled

)

Set the enabled state of the light.

Parameters

state

Enable state.

Enable the component. EOnCameraFrame is not evaluated for disabled components.

Parameters

[in]

True

to enable the component, false to disable it

Definition at line 231 of file SCR_BaseManualCameraComponent.c.

SetFogAmountOverride()

proto external bool SetFogAmountOverride	(	bool	doOverride,
		float	fog = 0 )

Sets current fog override (in range <0.0, 1.0>) Can only be set by the authority (server, singleplayer...)

Returns

Returns true when command is authorized, false otherwise.

SetFogHeightDensityOverride()

proto external bool SetFogHeightDensityOverride	(	bool	doOverride,
		float	heightDensity = 0 )

SetHoursMinutesSeconds()

proto external bool SetHoursMinutesSeconds	(	int	hours,
		int	minutes,
		int	seconds,
		bool	immediateChange = false )

Sets the current time of the day. Only issuable by the authority. Automatically broadcast to all clients.

Parameters

hours	Hours <0,24>
minutes	Minutes <0,60>
seconds	Seconds <0,60>
immediateChange	Whether change should be applied immediately, forcing recomputation. This should be true only in case of editor and similar items.

Returns

Returns true when command is issued successfully, false otherwise. Example:

SetHoursMinutesSeconds(16, 30, 00);
int h, m, s;
GetHoursMinutesSeconds(h, m, s);
Print(h);
Print(m);
Print(s);
 
>> int h = 16
>> int m = 30
>> int s = 00

SetIntensityEVClip()

proto external void SetIntensityEVClip

(

float

clipEV

)

Sets light intensity clip in EV. Lights is clipped when its intensity is low but this could be too early for some lights. This value is bias to move the intensity clip test. The value is in EV thus 1 unit means double of light

Parameters

clipEV

Negative values make the test less strict, useful e.g. for lights with low intensities lying near geometry

SetIsDayAutoAdvanced()

proto external bool SetIsDayAutoAdvanced

(

bool

autoAdvanced

)

Enables or disabled automatic daytime advancement. Only issuable by the authority. Automatically broadcast to all clients.

Parameters

autoAdvanced

True to enable, false to disable.

Returns

Returns true when command is issued successfully, false otherwise.

SetLensFlareIndex()

proto external void SetLensFlareIndex

(

int

index

)

Sets lens flare index of a light. Use value < 0 to disable lens flare

Parameters

index

Index of the lens flare in the world lens flare config

SetLensFlareOffset()

proto external void SetLensFlareOffset

(

vector

offset

)

Sets lens flare offset for a light

Parameters

offset

Offset from the light original position vector(offset, offsetUp, offsetSide)

SetLensFlareScale()

proto external void SetLensFlareScale

(

float

scale

)

Sets lens flare scale for a light

Parameters

scale

Scale of the lens flare

SetLensFlareType()

proto external void SetLensFlareType

(

LightLensFlareType

type

)

Sets lens flare type of a light.

Parameters

type	Lens flare type (Automatic = lens flare is determined by light type, Manual = use index, Disabled = lens flare disabled)

SetLightCameraMask()

proto external int SetLightCameraMask

(

int

mask

)

Set mask for light vs camera visibility. By default, all bits are set what means the light will be visible in all cameras

Parameters

mask	Bit-mask of cameras where is light visible

Returns

Returns previous mask

SetLightDirection()

proto external void SetLightDirection

(

vector

direction

)

Sets direction of light. It's meaningful for LT_SPOT/LT_DIRECTIONAL only!

Parameters

direction

Direction of light

SetLightFlags()

proto external int SetLightFlags

(

LightFlags

flags

)

Set light flags

Warning

If you want to convert a static light to dynamic light, you need to delete the current static light and spawn a new light with the dynamic flag set.

Parameters

flags

new flags combined internally with older flags

Returns

currently set flags

SetManagerSignals()

proto external void SetManagerSignals

(

)

Sets default used MusicManager signals.

SetNearPlane()

proto external void SetNearPlane

(

float

nearPlane

)

Sets near plane of a light. It's meaningful for shadow casting LT_SPOT/LT_POINT lights only!

Parameters

nearPlane

near plane when casting shadows in meters

SetOnFinishedCallback()

proto external void SetOnFinishedCallback

(

func

fn

)

SetOverrideSunIrradiance()

proto external bool SetOverrideSunIrradiance

(

bool

doOverride

)

Sets if Sun irradiance override is enabled

Returns

true if command was succesful

SetOverrideTemperature()

proto external bool SetOverrideTemperature

(

bool

doOverride

)

Sets if temperature override is enabled

Returns

true if command was succesful

SetPoints()

proto external void SetPoints	(	array< vector >	points,
		IEntitySource	entSource,
		int	placeFirstAtIdx = 0 )

Reconstructs the shape from the points in the points array, or by adding it after first paceFirstAtIdx points. points are the points to be added, entSource is the source of the shape entity. placeFirstAtIdx allows to keep the first (placeFirstAtIdx - 1) existing points of the spline and adds new points after those.

SetPointsSpline()

proto external void SetPointsSpline	(	array< vector >	points,
		IEntitySource	entSource,
		float	tangentLengthIn,
		float	tangentLengthOut,
		int	placeFirstAtIdx = 0 )

Reconstructs the shape from the points in the points array, or by adding it after first paceFirstAtIdx points. points are the points to be added, entSource is the source of the shape entity. tangentLengthIn/Out allow to multiply the length of the tangents instead of the usual 0.5. placeFirstAtIdx allows to keep the first (placeFirstAtIdx - 1) existing points of the spline and adds new points after those.

SetProbePosition()

EnvironmentProbeEntityClass VolumeReceiverEntityClass SetProbePosition	(	vector	position,
		bool	invalidate )

Set new probe position

Parameters

position
invalidate	invalidate probe data to capture them again

SetRadius()

proto external void SetRadius

(

float

radius

)

Set light's new radius

Parameters

radius

light radius in meters

SetRainIntensityOverride()

proto external bool SetRainIntensityOverride	(	bool	doOverride,
		float	rainIntensity = 0 )

Sets current rain intensity override (in range <0.0, 1.0>) Can only be set by the authority (server, singleplayer...)

Returns

Returns true when command is authorized, false otherwise.

SetReflectionEV()

proto external void SetReflectionEV

(

float

EV

)

Set EV for reflection, this changes the probe definition part

Parameters

EV	0 is original probe value

SetSignalValue()

proto external void SetSignalValue	(	int	index,
		float	value )

Set signal value by 'index'. Index is obtained by GetSignalIndex method.

SetSignalValueStr()

proto external void SetSignalValueStr	(	string	signal,
		float	value )

Set signal value by signal name.

SetSunIrradianceOverrideValues()

proto external bool SetSunIrradianceOverrideValues	(	float	sunIrradianceMin,
		float	sunIrradianceMax )

Sets values for Sun Irradiance override (values are for min/max during the day)

Returns

true if command was succesful

SetTemperatureOverrideValues()

proto external bool SetTemperatureOverrideValues	(	float	temperatureAirMin,
		float	temperatureAirMax,
		float	temperatureSkyMin,
		float	temperatureSkyMax,
		float	temperatureWaterMin,
		float	temperatureWaterMax )

Sets values for temperature override (in degrees Celsius). Values are for min/max during the day.

Returns

true if command was succesful

SetTexture()

proto external void SetTexture

(

ResourceName

textureName

)

Sets color-lookup texture, light color with LV is multiplied by the texture point lights -> texture must be cube map spot lights, 2D texture -> the texture serves as projector texture spot light, 1D texture of <someWidth, 1> size -> texture serves is angle lookup texture (parametrized by cos^2 angle from spot direction and pixel world pos, IES profile, but not supported fully now as we don't have IES converter)

Parameters

textureName

Name of texture

SetTimeOfTheDay()

proto external bool SetTimeOfTheDay	(	float	hours24,
		bool	immediateChange = false )

Sets the current time of the day. Only issuable by the authority. Automatically broadcast to all clients.

Parameters

hours24	Time fraction in hours <0.0, 24.0>
immediateChange	Whether change should be applied immediately, forcing recomputation. This should be true only in case of editor and similar items.

Returns

Returns true when command is issued successfully, false otherwise. Example:

SetTimeOfTheDay(16.5);
int h, m, s;
GetHoursMinutesSeconds(h, m, s);
Print(h);
Print(m);
Print(s);
 
>> int h = 16
>> int m = 30
>> int s = 00

SetTimeZoneOffset()

proto external bool SetTimeZoneOffset

(

float

utcTimeZone

)

Sets time zone offset (in hours) in range <-12.0, +14.0>

SetVolumeEffect()

proto external void SetVolumeEffect	(	float	intensity,
		float	offset,
		float	scale )

Sets light volumetric effect

Parameters

intensity	vol light intensity
offset	signed offset of light volume effect according base light
scale	scale of light (mainly for optimization)

SetWindDirectionOverride()

proto external bool SetWindDirectionOverride	(	bool	doOverride,
		float	windDirection = 0 )

Sets in-game wind direction angle in degrees. Only issuable by the authority. Automatically broadcast to all clients.

Parameters

windDirection

Wind direction angle in degrees <0, 360.0>

Returns

Returns true when command is issued successfully, false otherwise.

SetWindSpeedOverride()

proto external bool SetWindSpeedOverride	(	bool	doOverride,
		float	windSpeed = 0 )

Sets in-game wind speed in meters per second. Only issuable by the authority. Automatically broadcast to all clients.

Parameters

windSpeed

Wind speed in m/s.

Returns

Returns true when command is issued successfully, false otherwise.

Stop() [1/2]

proto external void Stop

(

)

Stop tracking time in this menu, prepare for sending data.

Stop the animation.

Stop tracking time in this menu, prepare for sending data.

Definition at line 30 of file SCR_AnalyticsDelayedSend.c.

Stop() [2/2]

proto external void Stop

(

string

musicName

)

Stops either a specific Music that is playing by name OR stops whatever is currently playing (when the string is empty).

StopCameraAnimation()

proto external void StopCameraAnimation

(

)

Teleport()

BaseGameEntityClass GenericEntityClass Teleport

(

vector

mat[4]

)

Teleport the entity to a coordinate

Parameters

mat	The matrix used for the teleportation

TerrToWorldCoord()

proto external vector TerrToWorldCoord

(

vector

terrpos

)

convert point from terrain to world coordinates.

Parameters

terrpos

terrpos

Returns

worldpos

TryGetHeightTC()

proto bool TryGetHeightTC	(	float	x,
		float	z,
		out float	y )

UpdateRectsFromQueue()

proto external void UpdateRectsFromQueue

(

)

UpdateWeather()

proto external void UpdateWeather	(	float	timeSlice,
		bool	advanceSimulation = true )

update weather by selected timeSlice

Parameters

timeSlice	timeslice
advanceSimulation	advance simulation time by the timeslice value, if false, only weather is updated

WB_DisableAutoReinits()

proto external void WB_DisableAutoReinits

(

)

WB_EnableAutoReinits()

RoadEntityClass GenericEntityClass WB_EnableAutoReinits

(

)

WorldToTerrCoord()

proto external vector WorldToTerrCoord

(

vector

worldpos

)

Convert point from world to terrain coordinates.

Parameters

worldpos

worldpos

Returns

terrpos

Variable Documentation

m_fMaterialVariable

VehiclePartPanelClass m_fMaterialVariable = 0

Read-only variable filled from code, used to animate material.