Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
previous class next class | frames no frames |
00001 00002 00003 00004 00005 00006 00007 00008 00009 00010 00011 00012 00013 00014 00015 00016 00017 00018 00019 00020 00021 00022 00023 00024 00025 00026 00027 00028 00029 00030 00031 00032 00033 00034 00035 00036 00037 00038 00039 00040 00041 00042 00043 00044 00045 00046 00047 00048 00049 00050 00051 00052 00053 00054 00055 00056 00057 00058 00059 00060 |
/** * This datastore provides access to a list of data providers which provide data for any file which is handled by * the engine's config cache system, such as .ini and .int files. * * There is one ConfigFileProvider for each ini/int file, and contains a list of providers for sections in that file. * * Copyright 1998-2011 Epic Games, Inc. All Rights Reserved. */ class UIConfigFileProvider extends UIConfigProvider native(inherit) transient; /** the list of sections in this config file */ var transient array<UIConfigSectionProvider> Sections; /** the name of the config file associated with this data provider */ var noexport transient string ConfigFileName; cpptext { /** the name of the config file associated with this data provider */ FFilename ConfigFileName; /* === UIConfigFileProvider interface === */ /** * Initializes this config file provider, creating the section data providers for each of the sections contained * within the ConfigFile specified. * * @param ConfigFile the config file to associated with this data provider */ void InitializeProvider( class FConfigFile* ConfigFile ); /* === UIDataProvider interface === */ /** * Resolves the value of the data field specified and stores it in the output parameter. * * @param FieldName the data field to resolve the value for; guaranteed to correspond to a property that this provider * can resolve the value for (i.e. not a tag corresponding to an internal provider, etc.) * @param out_FieldValue receives the resolved value for the property specified. * @see GetDataStoreValue for additional notes * @param ArrayIndex optional array index for use with data collections * * @todo - not yet implemented */ virtual UBOOL GetFieldValue( const FString& FieldName, struct FUIProviderFieldValue& out_FieldValue, INT ArrayIndex=INDEX_NONE ); /** * Gets the list of data fields exposed by this data provider. * * @param out_Fields will be filled in with the list of tags which can be used to access data in this data provider. * Will call GetScriptDataTags to allow script-only child classes to add to this list. */ virtual void GetSupportedDataFields( TArray<struct FUIDataProviderField>& out_Fields ); } DefaultProperties { } |
Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
previous class next class | frames no frames |