I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX
UE3:UIDynamicDataProvider (UT3)
 |
Object >> UIRoot >> UIDataProvider >> UIPropertyDataProvider >> UIDynamicDataProvider |
Contents
- Package:
- Engine
- Direct subclasses:
- InventoryDataProvider, GameInfoDataProvider, PickupDataProvider, PlayerDataProvider, TeamDataProvider, UIDataProvider_Settings
- This class in other games:
- UDK
| 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. |
Provides data about a particular instance of an actor in the game.
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved
Properties[edit]
DataClass[edit]
Type: Class
Modifiers: const
The metaclass for this data provider. Each instance of this class (including instances of child classes) will have a data provider that tells the UI which properties to provide for this class. Classes indicate which properties are available for use by dynamic data stores by marking the property with a keyword.
DataSource[edit]
Type: Object
Modifiers: const, transient, protected
The object that this data provider is presenting data for. Set by calling BindProviderInstance.
Functions[edit]
Native functions[edit]
BindProviderInstance[edit]
Associates this data provider with the specified instance.
Parameters:
- DataSourceInstance - a pointer to the object instance that this data provider should present data for. DataSourceInstance must be of type DataClass.
Returns:
- TRUE if the instance specified was successfully associated with this data provider. FALSE if the object specified wasn't of the correct type or was otherwise invalid.
UnbindProviderInstance[edit]
Clears the instance associated with this data provider.
Returns:
- TRUE if the instance reference was successfully cleared.
Events[edit]
IsValidDataSourceClass[edit]
Script hook for preventing a particular child of DataClass from being represented by this dynamic data provider.
Parameters:
- PotentialDataSourceClass - a child class of DataClass that is being considered as a candidate for binding by this provider.
Returns:
- return FALSE to prevent PotentialDataSourceClass's properties from being added to the UI editor's list of bindable properties for this data provider; also prevents any instances of PotentialDataSourceClass from binding to this provider at runtime.
ProviderInstanceBound[edit]
Called once BindProviderInstance has successfully verified that DataSourceInstance is of the correct type. Child classes can override this function to handle storing the reference, for example.
ProviderInstanceUnbound[edit]
Called immediately after this data provider's DataSource is disassociated from this data provider.
Other instance functions[edit]
CleanupDataProvider[edit]
Allows the data provider to clear any references that would interfere with garbage collection.
Returns:
- TRUE if the instance reference was successfully cleared.
GetDataSource[edit]
Returns a reference to the data source associated with this data provider.
