UE3:UTUIDataProvider AvailableContent (UT3): Difference between revisions

From Unreal Wiki, The Unreal Engine Documentation Site
Auto-generated page
 
m added missing members
 
Line 10: Line 10:
Dataprovider that returns a row for each available content package.
Dataprovider that returns a row for each available content package.


Copyright 1998-2007 Epic Games, Inc. All Rights Reserved
Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.


==Properties==
==Properties==
====AllAchievements====
'''Type:''' [[array]]<{{tl|AchievementParent}}>
'''[[Variables#Modifiers|Modifiers]]:''' transient
<!-- enter variable description -->
====CurrentAchievementView====
'''Type:''' [[array]]<[[pointer]]''{FAchievementUIInfo}''>
'''[[Variables#Modifiers|Modifiers]]:''' transient
<!-- enter variable description -->
====GameModeMappings====
'''Type:''' [[array]]<{{tl|GameModeMapping}}>
'''[[Variables#Modifiers|Modifiers]]:''' transient
<!-- enter variable description -->
====MutatorMappings====
'''Type:''' [[array]]<{{tl|MutatorMapping}}>
'''[[Variables#Modifiers|Modifiers]]:''' transient
<!-- enter variable description -->
====Packages====
====Packages====
'''Type:''' [[array]]<{{tl|AvailableContentPackage}}>
'''Type:''' [[array]]<{{tl|AvailableContentPackage}}>
'''[[Variables#Modifiers|Modifiers]]:''' transient
<!-- enter variable description -->
====VehicleMappings====
'''Type:''' [[array]]<{{tl|VehicleMapping}}>


'''[[Variables#Modifiers|Modifiers]]:''' transient
'''[[Variables#Modifiers|Modifiers]]:''' transient
Line 21: Line 56:


==Structs==
==Structs==
===AchievementParent===
'''[[Structs#Modifiers|Modifiers]]:''' native
<!-- enter struct description -->
; {{tl|AchievementUIInfo}} Achievement : <!-- enter variable description -->
; [[array]]<{{tl|AchievementUIInfo}}> SubAchievements : <!-- enter variable description -->
===AchievementUIInfo===
'''[[Structs#Modifiers|Modifiers]]:''' native
all of the achievements possible *
; [[int]] ID : <!-- enter variable description -->
; [[bool]] bIsCollapsable : <!-- enter variable description -->
; [[bool]] bIsExpanded : can this be expanded/collapsed *
; [[string]] Name : <!-- enter variable description -->
; [[string]] HowTo : <!-- enter variable description -->
; [[string]] ProgressStr : markup for how to complete the award *
; [[string]] IconStr : markup for progress text *
; {{tl|TextureCoordinates|UIRoot|structs}} IconCoordinates : markup for award icon *
===AvailableContentPackage===
===AvailableContentPackage===
'''[[Structs#Modifiers|Modifiers]]:''' native
'''[[Structs#Modifiers|Modifiers]]:''' native
Line 29: Line 84:
; [[string]] ContentDescription : <!-- enter variable description -->
; [[string]] ContentDescription : <!-- enter variable description -->


==Native functions==
===GameModeMapping===
'''[[Structs#Modifiers|Modifiers]]:''' native
 
<!-- enter struct description -->
; [[int]] GameModeID : ID from PBD for gamemode/achievement map
; [[string]] GameModeClassName : Classname of game mode
; [[string]] MarkupStr : Markup for new icons
 
===MutatorMapping===
'''[[Structs#Modifiers|Modifiers]]:''' native
 
<!-- enter struct description -->
; [[int]] MutatorBit : ID from PBD for mutator bit
; [[string]] MutatorClassName : <!-- enter variable description -->
 
===VehicleMapping===
'''[[Structs#Modifiers|Modifiers]]:''' native
 
<!-- enter struct description -->
; [[int]] VehicleIndex : ID from PBD for vehicle index
; [[string]] VehicleName : <!-- enter variable description -->
 
==Functions==
===Native functions===
====GetElementCount====
====GetElementCount====
{{code|native function [[int]]&nbsp;'''GetElementCount''' ()}}
{{code|native function [[int]]&nbsp;'''GetElementCount''' ()}}
Line 42: Line 120:


Parses a string for downloadable content.
Parses a string for downloadable content.
====ToggleCollapse====
{{code|native function '''ToggleCollapse''' ([[int]]&nbsp;'''CurrentIndex''')}}
Recreate the data store given an index to collapse
===Other instance functions===
====ConvertSecondsToString====
{{code|function [[string]]&nbsp;'''ConvertSecondsToString''' ([[int]]&nbsp;'''NumSeconds''')}}
<!-- enter function description -->
====CountBits====
{{code|function [[int]]&nbsp;'''CountBits''' ([[int]]&nbsp;'''value''')}}
Count the number of bits on a value *
====GetByteValue====
{{code|function [[int]]&nbsp;'''GetByteValue''' ([[int]]&nbsp;'''value''', [[int]]&nbsp;'''index''')}}
Return the byte value within a dword *
====GetGameModeName====
{{code|function [[bool]]&nbsp;'''GetGameModeName''' (out&nbsp;[[array]]<{{cl|UTUIResourceDataProvider}}>&nbsp;'''ProviderList''', [[string]]&nbsp;'''GameModeClassName''', out&nbsp;[[string]]&nbsp;'''FriendlyName''')}}
<!-- enter function description -->
====GetMapNameAndMarkup====
{{code|function [[bool]]&nbsp;'''GetMapNameAndMarkup''' (out&nbsp;[[array]]<{{cl|UTUIResourceDataProvider}}>&nbsp;'''ProviderList''', [[string]]&nbsp;'''MapName''', out&nbsp;[[string]]&nbsp;'''NewMapName''', out&nbsp;[[string]]&nbsp;'''Markup''')}}
<!-- enter function description -->
====GetMatchingProfileId====
{{code|function [[int]]&nbsp;'''GetMatchingProfileId''' ({{cl|UTProfileSettings}}&nbsp;'''Profile''', [[int]]&nbsp;'''MatchingId''')}}
GetMatchingProfileId
====GetMutatorName====
{{code|function [[bool]]&nbsp;'''GetMutatorName''' (out&nbsp;[[array]]<{{cl|UTUIResourceDataProvider}}>&nbsp;'''ProviderList''', [[string]]&nbsp;'''MutatorClassName''', out&nbsp;[[string]]&nbsp;'''FriendlyName''')}}
<!-- enter function description -->
====GetVehicleName====
{{code|function '''GetVehicleName''' ([[string]]&nbsp;'''VehicleClassName''', out&nbsp;[[string]]&nbsp;'''FriendlyName''')}}
<!-- enter function description -->
====SetupAchievementList====
{{code|function '''SetupAchievementList''' ({{cl|UTPlayerController}}&nbsp;'''PC''')}}
Setup the Achievement list that details the player's progress
'''Parameters:'''
* ''PC'' - Current scene player controller

Latest revision as of 06:01, 16 August 2009

UT3 Object >> UIRoot >> UIDataProvider >> UTUIDataProvider_SimpleElementProvider >> UTUIDataProvider_AvailableContent
Package:
UTGame
Implemented interfaces:
UIListElementCellProvider
This class in other games:
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

Dataprovider that returns a row for each available content package.

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Properties

AllAchievements

Type: array<AchievementParent>

Modifiers: transient


CurrentAchievementView

Type: array<pointer{FAchievementUIInfo}>

Modifiers: transient


GameModeMappings

Type: array<GameModeMapping>

Modifiers: transient


MutatorMappings

Type: array<MutatorMapping>

Modifiers: transient


Packages

Type: array<AvailableContentPackage>

Modifiers: transient


VehicleMappings

Type: array<VehicleMapping>

Modifiers: transient


Structs

AchievementParent

Modifiers: native

AchievementUIInfo Achievement
array<AchievementUIInfo> SubAchievements

AchievementUIInfo

Modifiers: native

all of the achievements possible *

int ID
bool bIsCollapsable
bool bIsExpanded
can this be expanded/collapsed *
string Name
string HowTo
string ProgressStr
markup for how to complete the award *
string IconStr
markup for progress text *
UIRoot.TextureCoordinates IconCoordinates
markup for award icon *

AvailableContentPackage

Modifiers: native

Struct that defines a content package

string ContentName
string ContentFriendlyName
string ContentDescription

GameModeMapping

Modifiers: native

int GameModeID
ID from PBD for gamemode/achievement map
string GameModeClassName
Classname of game mode
string MarkupStr
Markup for new icons

MutatorMapping

Modifiers: native

int MutatorBit
ID from PBD for mutator bit
string MutatorClassName

VehicleMapping

Modifiers: native

int VehicleIndex
ID from PBD for vehicle index
string VehicleName

Functions

Native functions

GetElementCount

native function int GetElementCount ()

Overrides: UTUIDataProvider_SimpleElementProvider.GetElementCount

Returns:

Returns the number of elements(rows) provided.

ParseContentString

native function ParseContentString (string ContentStr)

Parses a string for downloadable content.

ToggleCollapse

native function ToggleCollapse (int CurrentIndex)

Recreate the data store given an index to collapse

Other instance functions

ConvertSecondsToString

function string ConvertSecondsToString (int NumSeconds)


CountBits

function int CountBits (int value)

Count the number of bits on a value *

GetByteValue

function int GetByteValue (int value, int index)

Return the byte value within a dword *

GetGameModeName

function bool GetGameModeName (out array<UTUIResourceDataProvider> ProviderList, string GameModeClassName, out string FriendlyName)


GetMapNameAndMarkup

function bool GetMapNameAndMarkup (out array<UTUIResourceDataProvider> ProviderList, string MapName, out string NewMapName, out string Markup)


GetMatchingProfileId

function int GetMatchingProfileId (UTProfileSettings Profile, int MatchingId)

GetMatchingProfileId

GetMutatorName

function bool GetMutatorName (out array<UTUIResourceDataProvider> ProviderList, string MutatorClassName, out string FriendlyName)


GetVehicleName

function GetVehicleName (string VehicleClassName, out string FriendlyName)


SetupAchievementList

function SetupAchievementList (UTPlayerController PC)

Setup the Achievement list that details the player's progress

Parameters:

  • PC - Current scene player controller
Retrieved from "https://wiki.beyondunreal.com/index.php?title=UE3:UTUIDataProvider_AvailableContent_(UT3)&oldid=35235"