System

Classes
class	FileHandle
class	FileIO
class	FilePath
class	GameProject
class	GameSessionStorage
	GameSessionStorage is used to store data for whole lifetime of game executable run. Here can be stored data which must survive scripts/addons reloading. More...
class	ParseHandle
class	PixelRawData
class	ProfileData
	ProfileData is used to return profile data using System.GetProfileData(). More...
class	RandomGenerator
class	ScreenshotTextureData
class	ScriptModule
class	System
class	SearchResourcesFilter
	Object used for holding filtering params for ResourceDatabase.SearchResources() method. More...
class	MemoryStatsSnapshot
	Handle to a running process. More...
class	AIAmbientLightProbeSystem
class	AIFlockUpdateSystem
class	AIObstacleAvoidanceSystem
class	AISmartActionSystem
class	AIVehicleKnowledgeSystem
class	AoeDamageSystem
class	BirdAnimationsUpdateSystem
class	BoidsSystem
class	BuoyancySystem
class	CamerasSystem
class	CharacterIgnoreDamageSystem
class	CharacterLeaningSystem
class	DecalSystem
class	DestructionHeatmapSystem
class	DistanceParticleEffectSystem
class	FallDamageInspectorSystem
class	FlattenGrassSystem
class	FuelSystem
class	GameSystem
class	GarbageSystem
class	GarbageSystemConfig
class	GarbageSystemConfigComponentClass
class	HandleAimingUpdateSystem
class	HandleAnimatedColliderSystem
class	HandleAnimationsInterpolateSystem
class	HandleAnimationsKeyframeNwkSystem
class	HandleAnimationsKeyframeSystem
class	HandleAnimationsReplaySystem
class	HandleClothsPhysicUpdateSystem
class	HandleClothsPositionUpdateSystem
class	HandleControlsSystem
class	HandleDamageSystem
class	HandleFireRequestsSystem
class	HandleItemAnimationsSystem
class	HandlePlayerControllersUpdateSystem
class	HandleRagdollSystem
class	HitRegistrationSystem
class	HUDSystem
class	InteractionBlockSystem
class	InteractionSystem
class	InventoryStreamingSystem
class	InventorySystem
class	LightManagersSystem
class	LongRangeSoundSystem
class	NwkMovementConsumerSystem
class	NwkMovementProducerSystem
class	PerceivableSystem
class	PerceptionSystem
class	ProcAnimSystem
class	ProjectileSimulationSystem
class	RecordInactivePhysEntitiesStateSystem
class	ReplicatedCamerasSystem
class	RespawnSystem
class	RestoreInactivePhysEntitiesStateSystem
class	RoadNetworkSystem
class	RplComponentDebugDrawSystem
class	SignalsManagersSystem
class	StaminaSystem
class	TagSystem
class	VehicleDebugDrawSystem
class	VehicleLightPortalSystem
class	VehiclePostSimulationSystem
class	VehicleSimulationSystem
class	VehicleUpdateAnimsSystem
class	VehicleUpdateSignalsSystem
class	VicinitySystem
class	VolumesDebugSystem
class	VoNSystem

Typedefs
typedef func	FindFilesCallback
typedef func	ScreenshotRawDataCallback
typedef func	ScreenshotTextureCallback
typedef func	GetTextureRawDataCallback

Enumerations
enum	EPlatform {   WINDOWS = 1 << EPlatform.WINDOWS , LINUX = 1 << EPlatform.LINUX , XBOX_ONE = 1 << EPlatform.XBOX_ONE , XBOX_ONE_S = 1 << EPlatform.XBOX_ONE_S ,   XBOX_ONE_X = 1 << EPlatform.XBOX_ONE_X , XBOX_SERIES_S = 1 << EPlatform.XBOX_SERIES_S , XBOX_SERIES_X = 1 << EPlatform.XBOX_SERIES_X , PS4 = 1 << EPlatform.PS4 ,   PS5 = 1 << EPlatform.PS5 , PS5_PRO = 1 << EPlatform.PS5_PRO , UNKNOWN = 1 << EPlatform.UNKNOWN , WINDOWS = 1 << EPlatform.WINDOWS ,   LINUX = 1 << EPlatform.LINUX , XBOX_ONE = 1 << EPlatform.XBOX_ONE , XBOX_ONE_S = 1 << EPlatform.XBOX_ONE_S , XBOX_ONE_X = 1 << EPlatform.XBOX_ONE_X ,   XBOX_SERIES_S = 1 << EPlatform.XBOX_SERIES_S , XBOX_SERIES_X = 1 << EPlatform.XBOX_SERIES_X , PS4 = 1 << EPlatform.PS4 , PS5 = 1 << EPlatform.PS5 ,   PS5_PRO = 1 << EPlatform.PS5_PRO , UNKNOWN = 1 << EPlatform.UNKNOWN }
enum	EPlatform {   WINDOWS = 1 << EPlatform.WINDOWS , LINUX = 1 << EPlatform.LINUX , XBOX_ONE = 1 << EPlatform.XBOX_ONE , XBOX_ONE_S = 1 << EPlatform.XBOX_ONE_S ,   XBOX_ONE_X = 1 << EPlatform.XBOX_ONE_X , XBOX_SERIES_S = 1 << EPlatform.XBOX_SERIES_S , XBOX_SERIES_X = 1 << EPlatform.XBOX_SERIES_X , PS4 = 1 << EPlatform.PS4 ,   PS5 = 1 << EPlatform.PS5 , PS5_PRO = 1 << EPlatform.PS5_PRO , UNKNOWN = 1 << EPlatform.UNKNOWN , WINDOWS = 1 << EPlatform.WINDOWS ,   LINUX = 1 << EPlatform.LINUX , XBOX_ONE = 1 << EPlatform.XBOX_ONE , XBOX_ONE_S = 1 << EPlatform.XBOX_ONE_S , XBOX_ONE_X = 1 << EPlatform.XBOX_ONE_X ,   XBOX_SERIES_S = 1 << EPlatform.XBOX_SERIES_S , XBOX_SERIES_X = 1 << EPlatform.XBOX_SERIES_X , PS4 = 1 << EPlatform.PS4 , PS5 = 1 << EPlatform.PS5 ,   PS5_PRO = 1 << EPlatform.PS5_PRO , UNKNOWN = 1 << EPlatform.UNKNOWN }
enum	FileAttribute {   DIRECTORY , HIDDEN , READONLY , COMPRESSED ,   ARCHIVE , SYSTEM , NOINDEXED , ENCRYPTED ,   ISCREATOR , INVALID , DIRECTORY , HIDDEN ,   READONLY , COMPRESSED , ARCHIVE , SYSTEM ,   NOINDEXED , ENCRYPTED , ISCREATOR , INVALID }
	File attributes. See FileDescription. More...
enum	FileAttribute {   DIRECTORY , HIDDEN , READONLY , COMPRESSED ,   ARCHIVE , SYSTEM , NOINDEXED , ENCRYPTED ,   ISCREATOR , INVALID , DIRECTORY , HIDDEN ,   READONLY , COMPRESSED , ARCHIVE , SYSTEM ,   NOINDEXED , ENCRYPTED , ISCREATOR , INVALID }
enum	FileMode {   READ , OPENW , WRITE , APPEND ,   MASK , FILEFLAGS_NO_PREREAD , READ , OPENW ,   WRITE , APPEND , MASK , FILEFLAGS_NO_PREREAD }
	Mode for opening file. See FileSystem::Open. More...
enum	FileMode {   READ , OPENW , WRITE , APPEND ,   MASK , FILEFLAGS_NO_PREREAD , READ , OPENW ,   WRITE , APPEND , MASK , FILEFLAGS_NO_PREREAD }

Functions
void	SearchResourcesCallback (ResourceName resourceName, string exactPath="")
void	FindFilesCallback (string fileName, FileAttribute attributes=0, string filesystem=string.Empty)
void	ScreenshotRawDataCallback (PixelRawData data, int imageWidth, int imageHeight, int stride)
void	ScreenshotTextureCallback (ScreenshotTextureData data)
void	GetTextureRawDataCallback (PixelRawData data, int imageWidth, int imageHeight, int stride)

Variables
SearchResourcesFilter	SearchResourcesCallback
	Callback used for processing results from ResourceDatabase.SearchResources() method.

Detailed Description

Enforce script system methods

Typedef Documentation

FindFilesCallback

typedef func FindFilesCallback

Definition at line 21 of file System.c.

GetTextureRawDataCallback

typedef func GetTextureRawDataCallback

texture data callback API, returned texture in RGBA8 format

Definition at line 57 of file System.c.

ScreenshotRawDataCallback

typedef func ScreenshotRawDataCallback

screenshot callback API, returned data are in RGBA8 format -> each channel has 8 bits and four channels are used thus size in bytes for one pixel is 4 and the int type can be used for simpler work

example how to access pixel data on further c++ side:

for (int y = 0; y < height; y++)
{
    int const* row = (int const*) (((char const*) data) + stride);
    for (int x = 0; x < width; x++)
    {
        int pixel = row[x];
        ...
    }
}

Parameters

pixels	pointer to raw pixels
width	width of image data
height	height of image data
stride	stride is offset to next row - it doesn't need to be same like image width due to GPU data alignment rules

Definition at line 45 of file System.c.

ScreenshotTextureCallback

typedef func ScreenshotTextureCallback

screenshot callback API, returned texture in RGBA8 format

Definition at line 51 of file System.c.

Enumeration Type Documentation

EPlatform [1/2]

enum EPlatform

Enumerator
WINDOWS
LINUX
XBOX_ONE
XBOX_ONE_S
XBOX_ONE_X
XBOX_SERIES_S
XBOX_SERIES_X
PS4
PS5
PS5_PRO
UNKNOWN
WINDOWS
LINUX
XBOX_ONE
XBOX_ONE_S
XBOX_ONE_X
XBOX_SERIES_S
XBOX_SERIES_X
PS4
PS5
PS5_PRO
UNKNOWN

Definition at line 12 of file EPlatform.c.

EPlatform [2/2]

enum EPlatform

Enumerator
WINDOWS
LINUX
XBOX_ONE
XBOX_ONE_S
XBOX_ONE_X
XBOX_SERIES_S
XBOX_SERIES_X
PS4
PS5
PS5_PRO
UNKNOWN
WINDOWS
LINUX
XBOX_ONE
XBOX_ONE_S
XBOX_ONE_X
XBOX_SERIES_S
XBOX_SERIES_X
PS4
PS5
PS5_PRO
UNKNOWN

Definition at line 12 of file EPlatform.c.

FileAttribute [1/2]

enum FileAttribute

File attributes. See FileDescription.

Enumerator
DIRECTORY	File is directory.
HIDDEN	File is hidden.
READONLY	File is read-only.
COMPRESSED	File is from compressed archive.
ARCHIVE	File is archived.
SYSTEM
NOINDEXED
ENCRYPTED
ISCREATOR	For consoles, it indicates, that the file is created by current user.
INVALID
DIRECTORY	File is directory.
HIDDEN	File is hidden.
READONLY	File is read-only.
COMPRESSED	File is from compressed archive.
ARCHIVE	File is archived.
SYSTEM
NOINDEXED
ENCRYPTED
ISCREATOR	For consoles, it indicates, that the file is created by current user.
INVALID

Definition at line 13 of file FileAttribute.c.

FileAttribute [2/2]

enum FileAttribute

Enumerator
DIRECTORY	File is directory.
HIDDEN	File is hidden.
READONLY	File is read-only.
COMPRESSED	File is from compressed archive.
ARCHIVE	File is archived.
SYSTEM
NOINDEXED
ENCRYPTED
ISCREATOR	For consoles, it indicates, that the file is created by current user.
INVALID
DIRECTORY	File is directory.
HIDDEN	File is hidden.
READONLY	File is read-only.
COMPRESSED	File is from compressed archive.
ARCHIVE	File is archived.
SYSTEM
NOINDEXED
ENCRYPTED
ISCREATOR	For consoles, it indicates, that the file is created by current user.
INVALID

Definition at line 13 of file FileAttribute.c.

FileMode [1/2]

enum FileMode

Mode for opening file. See FileSystem::Open.

Enumerator
READ	File is readonly.
OPENW	File is just opened for write.
WRITE	File is read-write. When do not exists, it's created.
APPEND	File pointer is set to end of file.
MASK
FILEFLAGS_NO_PREREAD
READ	File is readonly.
OPENW	File is just opened for write.
WRITE	File is read-write. When do not exists, it's created.
APPEND	File pointer is set to end of file.
MASK
FILEFLAGS_NO_PREREAD

Definition at line 13 of file FileMode.c.

FileMode [2/2]

enum FileMode

Enumerator
READ	File is readonly.
OPENW	File is just opened for write.
WRITE	File is read-write. When do not exists, it's created.
APPEND	File pointer is set to end of file.
MASK
FILEFLAGS_NO_PREREAD
READ	File is readonly.
OPENW	File is just opened for write.
WRITE	File is read-write. When do not exists, it's created.
APPEND	File pointer is set to end of file.
MASK
FILEFLAGS_NO_PREREAD

Definition at line 13 of file FileMode.c.

Function Documentation

FindFilesCallback()

void FindFilesCallback	(	string	fileName,
		FileAttribute	attributes = 0,
		string	filesystem = string.Empty )

GetTextureRawDataCallback()

void GetTextureRawDataCallback	(	PixelRawData	data,
		int	imageWidth,
		int	imageHeight,
		int	stride )

ScreenshotRawDataCallback()

void ScreenshotRawDataCallback	(	PixelRawData	data,
		int	imageWidth,
		int	imageHeight,
		int	stride )

ScreenshotTextureCallback()

void ScreenshotTextureCallback

(

ScreenshotTextureData

data

)

SearchResourcesCallback()

void SearchResourcesCallback	(	ResourceName	resourceName,
		string	exactPath = "" )

Variable Documentation

SearchResourcesCallback

SearchResourcesFilter SearchResourcesCallback

Callback used for processing results from ResourceDatabase.SearchResources() method.