Once I get that upgrade to 36-hour days, I will tackle that. – Mychaeel

Difference between revisions of "UE3:UTUIDataStore Options (UDK)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Talk)
 
(Talk)
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{infobox class
+
{{UE3:UTUIDataStore_Options (UT3)}}
| package = UTGame
+
| parent1 = UIDataStore_GameResource
+
| parent2 = UIDataStore
+
| parent3 = UIDataProvider
+
| parent4 = UIRoot
+
| parent5 = Object
+
| interface1 = UIListElementProvider
+
}}
+
{{autogenerated}}
+
Inherited version of the game resource datastore that exposes sets of options to the UI.
+
These option sets are then used to autogenerate widgets.
+
 
+
==Properties==
+
====DynamicProviders====
+
'''Type:''' [[array]]<{{cl|UTUIResourceDataProvider}}>
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' transient
+
 
+
Array of dynamically providers.
+
 
+
====OptionProviders====
+
'''Type:''' {{tl|MultiMap_Mirror|Object|structs}}''{TMultiMap<FName, class UUTUIResourceDataProvider*>}''
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' const, private, native, transient
+
 
+
<!-- enter variable description -->
+
 
+
===Default values===
+
{| class="list defaults"
+
! Property
+
! Value
+
|-
+
| {{tl|ElementProviderTypes||UIDataStore_GameResource}}[0]
+
|
+
{| class="list defaults"
+
! {{tl|GameResourceDataProvider||UIDataStore_GameResource|Member}}
+
! Value
+
|-
+
| ProviderClassName
+
| "UTGame.UTUIDataProvider_MenuOption"
+
|-
+
| ProviderTag
+
| 'OptionSets'
+
|}
+
|-
+
| {{tl|Tag||UIDataStore}}
+
| 'UTOptions'
+
|-
+
| {{tl|WriteAccessType||UIDataProvider}}
+
| {{tl|EProviderAccessType||UIDataProvider|ACCESS_WriteAll}}
+
|}
+
 
+
==Native functions==
+
====AppendToSet====
+
{{code|native function '''AppendToSet''' ([[name]]&nbsp;'''SetName''', [[int]]&nbsp;'''NumOptions''')}}
+
 
+
Appends N amount of providers to the specified set.
+
 
+
'''Parameters:'''
+
* ''SetName'' - Set to append to
+
* ''NumOptions'' - Number of options to append
+
 
+
====ClearSet====
+
{{code|native function '''ClearSet''' ([[name]]&nbsp;'''SetName''')}}
+
 
+
Clears all options in the specified set.
+
 
+
'''Parameters:'''
+
* ''SetName'' - Set to clear
+
 
+
====GetSet====
+
{{code|native function '''GetSet''' ([[name]]&nbsp;'''SetName''', out&nbsp;[[array]]<{{cl|UTUIResourceDataProvider}}>&nbsp;'''OutProviders''')}}
+
 
+
Retrieves a set of option providers.
+
 
+
'''Parameters:'''
+
* ''SetName'' - Set to retrieve
+
* ''OutProviders'' - Storage array for resulting providers.
+

Revision as of 06:12, 17 January 2010

UDK Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_GameResource >> UTUIDataStore_Options
Package: 
UTGame
Implemented interfaces
UIListElementProvider
This class in other games:
UT3

Inherited version of the game resource datastore that exposes sets of options to the UI. These option sets are then used to autogenerate widgets.

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

Properties

DynamicProviders

Type: array<UTUIResourceDataProvider>

Modifiers: transient

Array of dynamically providers.

OptionProviders

Type: Object.MultiMap_Mirror{TMultiMap<FName, class UUTUIResourceDataProvider*>}

Modifiers: const, private, native, transient

collection of providers per part type.

Default values

Property Value
ElementProviderTypes[0]
Member Value
ProviderClassName "UTGame.UTUIDataProvider_MenuOption"
ProviderTag 'OptionSets'
Tag 'UTOptions'
WriteAccessType ACCESS_WriteAll

Native functions

AppendToSet

native function AppendToSet (name SetName, int NumOptions)

Appends N amount of providers to the specified set.

Parameters:

  • SetName - Set to append to
  • NumOptions - Number of options to append

ClearSet

native function ClearSet (name SetName)

Clears all options in the specified set.

Parameters:

  • SetName - Set to clear

GetSet

native function GetSet (name SetName, out array<UTUIResourceDataProviderOutProviders)

Retrieves a set of option providers.

Parameters:

  • SetName - Set to retrieve
  • OutProviders - Storage array for resulting providers.