I love the smell of UnrealEd crashing in the morning. – tarquin

UE3:OnlineStatsWrite (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 09:11, 17 May 2008 by Wormbo (Talk | contribs) (Auto-generated page)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UT3 Object >> OnlineStats >> OnlineStatsWrite
Package: 
Engine
Direct subclass:
UTLeaderboardWriteBase
This class in other games:
UDK

Stats class that accumulates the stats data before submitting it to the online subsytem for storage.

Properties[edit]

ArbitratedViewIds[edit]

Type: array<int>

Modifiers: const

This array contains the list of views to write the properties to for arbitrated matches

Properties[edit]

Type: array<Settings.SettingsProperty>

Modifiers: const

The array of properties to publish to the stats view

RatingId[edit]

Type: int

Modifiers: const

This is the property id that is used to rate on

StatMappings[edit]

Type: array<Settings.StringIdToStringMapping>

Modifiers: const

Maps the stat's column num to the human readable stat name

ViewIds[edit]

Type: array<int>

Modifiers: const

This array contains the list of views to write the properties to

Delegates[edit]

OnStatsWriteComplete[edit]

delegate OnStatsWriteComplete ()

Delegate used to notify the caller when stats write has completed

Native functions[edit]

DecrementFloatStat[edit]

native function DecrementFloatStat (int StatId, optional float DecBy)

Decrements a stat of type SDT_Float by the value specified. Does nothing if the stat is not of the right type.

Parameters:

  • StatId - the stat to decrement
  • DecBy - the value to decrement by

DecrementIntStat[edit]

native function DecrementIntStat (int StatId, optional int DecBy)

Decrements a stat of type SDT_Int by the value specified. Does nothing if the stat is not of the right type.

Parameters:

  • StatId - the stat to decrement
  • DecBy - the value to decrement by

GetStatId[edit]

native function bool GetStatId (name StatName, out int StatId)

Searches the stat mappings to find the stat id that matches the name

Parameters:

  • StatName - the name of the stat being searched for
  • StatId - the out value that gets the id

Returns:

true if it was found, false otherwise

GetStatName[edit]

native function name GetStatName (int StatId)

Searches the stat mappings to find human readable name for the stat id

Parameters:

  • StatId - the id of the stats to find the name for

Returns:

true if it was found, false otherwise

IncrementFloatStat[edit]

native function IncrementFloatStat (int StatId, optional float IncBy)

Increments a stat of type SDT_Float by the value specified. Does nothing if the stat is not of the right type.

Parameters:

  • StatId - the stat to increment
  • IncBy - the value to increment by

IncrementIntStat[edit]

native function IncrementIntStat (int StatId, optional int IncBy)

Increments a stat of type SDT_Int by the value specified. Does nothing if the stat is not of the right type.

Parameters:

  • StatId - the stat to increment
  • IncBy - the value to increment by

SetFloatStat[edit]

native function SetFloatStat (int StatId, float Value)

Sets a stat of type SDT_Float to the value specified. Does nothing if the stat is not of the right type.

Parameters:

  • StatId - the stat to change the value of
  • Value - the new value to assign to the stat

SetIntStat[edit]

native function SetIntStat (int StatId, int Value)

Sets a stat of type SDT_Int to the value specified. Does nothing if the stat is not of the right type.

Parameters:

  • StatId - the stat to change the value of
  • Value - the new value to assign to the stat