UE3:GameplayEvents (UDK)

Object >> GameplayEvents

Package: 

Engine

Direct subclasses:

GameplayEventsReader, GameplayEventsWriter

Gameplay event interface

Properties

ActorArray

Type: array<string>

The set of actors recorded during gameplay

Archive

Type: pointer{FArchive}

Modifiers: const, native

FArchive pointer to serialize the data to/from disk

CurrentSessionInfo

Type: GameSessionInformation

Information specific to the session when it was run

DamageClassArray

Type: array<DamageClassEventData>

The set of damage types recorded during gameplay

Header

Type: GameplayEventsHeader

Header of the gameplay events file

PawnClassArray

Type: array<PawnClassEventData>

The set of pawns recorded during gameplay

PlayerList

Type: array<PlayerInformationNew>

Modifiers: const

Array of all players 'seen' by the game in this session *

ProjectileClassArray

Type: array<ProjectileClassEventData>

The set of projectiles recorded during gameplay

SoundCueArray

Type: array<string>

The set of sound cues encountered during gameplay

StatsFileName

Type: string

Modifiers: const, private

The name of the file we are writing the data to (const so set only upon create natively)

SupportedEvents

Type: array<GameplayEventMetaData>

The set of events that the game supports writing to disk

Default value, index 0:

Member	Value
EventID	-1
EventName	'UNKNOWN'
MaxValue	1

Default value, index 1:

Member	Value
EventName	'MATCH STARTED'
MaxValue	1

Default value, index 2:

Member	Value
EventID	1
EventName	'MATCH ENDED'
MaxValue	1

Default value, index 3:

Member	Value
EventID	2
EventName	'ROUND STARTED'
MaxValue	1

Default value, index 4:

Member	Value
EventID	3
EventName	'ROUND ENDED'
MaxValue	1

Default value, index 5:

Member	Value
EventID	4
EventName	'MATCH WON'
MaxValue	1

Default value, index 6:

Member	Value
EventID	5
EventName	'MATCH LOST'
MaxValue	1

Default value, index 7:

Member	Value
EventID	6
EventName	'GAME TYPE'
MaxValue	1

Default value, index 8:

Member	Value
EventID	7
EventName	'GAME OPTIONS'
MaxValue	1

Default value, index 9:

Member	Value
EventID	8
EventName	'MAP NAME'
MaxValue	1

Default value, index 10:

Member	Value
EventID	9
EventName	'GAME SCORE'
MaxValue	1

Default value, index 11:

Member	Value
EventID	50
EventName	'TEAM FORMED'
MaxValue	1

Default value, index 12:

Member	Value
EventID	51
EventName	'TEAM SCORE UPDATE'
MaxValue	1

Default value, index 13:

Member	Value
EventID	100
EventName	'PLAYER LOGGED IN'
MaxValue	1

Default value, index 14:

Member	Value
EventID	101
EventName	'PLAYER LOGGED OUT'
MaxValue	1

Default value, index 15:

Member	Value
EventID	104
EventName	'PLAYER KILLED'
MaxValue	1

Default value, index 16:

Member	Value
EventID	106
EventName	'PLAYER TEAM CHANGE'
MaxValue	1

Default value, index 17:

Member	Value
EventID	102
EventName	'PLAYER SPAWNED'
MaxValue	1

Default value, index 18:

Member	Value
EventID	105
EventName	'PLAYER LOCATIONS'
MaxValue	1

Default value, index 19:

Member	Value
EventID	107
EventName	'KILL STREAK'
MaxValue	1

Default value, index 20:

Member	Value
EventID	103
EventName	'RECORD PLAYER WIN/LOSS'
MaxValue	1

Default value, index 21:

Member	Value
EventID	150
EventName	'WEAPON DAMAGE'
MaxValue	1

Default value, index 22:

Member	Value
EventID	151
EventName	'MELEE DAMAGE'
MaxValue	1

Default value, index 23:

Member	Value
EventID	152
EventName	'WEAPON FIRED'
MaxValue	1

Default value, index 24:

Member	Value
EventID	200
EventName	'NORMAL KILL'
MaxValue	1

Default value, index 25:

Member	Value
EventID	35
EventName	'MEMORY USAGE'
MaxValue	1

Default value, index 26:

Member	Value
EventID	37
EventName	'NETWORK USAGE IN'
MaxValue	1

Default value, index 27:

Member	Value
EventID	38
EventName	'NETWORK USAGE OUT'
MaxValue	1

Default value, index 28:

Member	Value
EventID	39
EventName	'Ping'
MaxValue	1

Default value, index 29:

Member	Value
EventID	36
EventName	'FRAME RATE'
MaxValue	1

TeamList

Type: array<TeamInformation>

Modifiers: const

Array of all teams 'seen' by the game in this session *

WeaponClassArray

Type: array<WeaponClassEventData>

The set of weapons recorded during gameplay

Structs

DamageClassEventData

Modifiers: native

Metadata describing the damage classes recorded during gameplay

string DamageClassName 

Name of the damage class used *

GameplayEventMetaData

Modifiers: native

Holds the information describing a gameplay event

int EventID 

The unique id of the event (16 bits clamped)

name EventName 

Human readable name of the event

Settings.EPropertyValueMappingType MappingType 

Index into array describing layout of event data

int MaxValue 

For integer stats, the max value that is possible for efficient bit packing

GameplayEventsHeader

Modifiers: native

int EngineVersion 

Version of engine at the time of writing the file

int StatsWriterVersion 

Version of the stats format at the time of writing the file

int StreamOffset 

Offset into the file for the stream data

int FooterOffset 

Offset into the file where the metadata is written

int TotalStreamSize 

Amount of data in the stream (not including header/footer data)

int FileSize 

File size on disk

GameSessionInformation

Modifiers: native

Game stats session information recorded at log start

int AppTitleID 

Unique title identifier

int PlatformType 

Platform the session was run on

string Language 

Language the session was run in

string GameplaySessionTimestamp 

Time this session was begun (real time)

float GameplaySessionStartTime 

Time this session was started (game time)

float GameplaySessionEndTime 

Time this session was ended (game time)

bool bGameplaySessionInProgress 

Is a session currently in progress

string GameplaySessionID 

Unique session ID

string GameClassName 

Name of the game class used

string MapName 

Name of map at time of session

string MapURL 

Game URL at time of session

PawnClassEventData

Modifiers: native

Metadata describing the pawn classes recorded during gameplay

string PawnClassName 

Name of the pawn class used *

PlayerInformationNew

Modifiers: native

List of player information cached in case the player logs out and GC collects the objects

string ControllerName 

Controller.Name

string PlayerName 

Controller.PlayerReplicationInfo.PlayerName

bool bIsBot 

Whether the player is a bot or not

ProjectileClassEventData

Modifiers: native

Metadata describing the projectile classes recorded during gameplay

string ProjectileClassName 

name of the projectile class used *

TeamInformation

Modifiers: native

List of team information cached during the play session

int TeamIndex 

Index of the team in game

string TeamName 

Name of the team

Object.Color TeamColor 

Color of the team

int MaxSize 

Max size during the game

WeaponClassEventData

Modifiers: native

Metadata describing the weapon classes recorded during gameplay

string WeaponClassName 

Name of the weapon class used *

Instance functions

CloseStatsFile

function CloseStatsFile ()

Closes and deletes the archive created clearing all data stored within

GetFilename

function string GetFilename ()

Retrieve the name of the file last in use by the gameplay event serializer, possibly empty

OpenStatsFile

function bool OpenStatsFile (string Filename)

Creates the archive that we are going to be manipulating

Parameters:

• Filename - name of the file that will be open for serialization

Returns:

TRUE if successful, else FALSE