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 00061 00062 00063 00064 00065 00066 00067 00068 00069 00070 00071 00072 00073 00074 00075 00076 00077 00078 00079 00080 00081 00082 00083 00084 00085 00086 00087 00088 00089 00090 00091 00092 00093 00094 00095 00096 00097 00098 00099 00100 00101 00102 00103 00104 00105 00106 00107 00108 00109 00110 00111 00112 00113 00114 00115 00116 00117 00118 00119 00120 00121 00122 00123 00124 00125 00126 00127 00128 00129 00130 00131 00132 00133 00134 00135 00136 00137 00138 00139 00140 00141 00142 00143 00144 00145 00146 00147 00148 00149 00150 00151 00152 00153 00154 00155 00156 00157 00158 00159 00160 00161 00162 00163 00164 00165 00166 00167 00168 00169 00170 00171 00172 00173 00174 00175 00176 00177 00178 00179 00180 00181 00182 00183 00184 00185 00186 00187 00188 00189 00190 00191 00192 00193 00194 00195 00196 00197 00198 00199 00200 00201 00202 00203 00204 00205 00206 00207 00208 00209 00210 00211 00212 00213 00214 00215 00216 00217 00218 00219 00220 00221 00222 00223 00224 00225 00226 00227 00228 00229 00230 00231 00232 00233 00234 00235 00236 00237 00238 00239 00240 00241 00242 00243 00244 00245 00246 00247 00248 00249 00250 00251 00252 00253 00254 00255 00256 00257 00258 00259 00260 00261 00262 00263 00264 00265 00266 00267 00268 00269 00270 00271 00272 00273 00274 00275 00276 00277 00278 00279 00280 00281 00282 00283 00284 00285 00286 00287 00288 00289 00290 00291 00292 00293 00294 00295 00296 00297 00298 00299 00300 00301 00302 00303 00304 00305 00306 00307 00308 00309 00310 00311 00312 00313 00314 00315 00316 00317 00318 00319 00320 00321 00322 00323 00324 00325 00326 00327 00328 00329 00330 00331 00332 00333 00334 00335 00336 00337 00338 00339 00340 00341 00342 00343 00344 00345 00346 00347 00348 00349 00350 00351 00352 00353 00354 00355 00356 00357 00358 00359 00360 00361 00362 00363 00364 00365 00366 00367 00368 00369 00370 00371 00372 00373 00374 00375 00376 00377 00378 00379 00380 00381 00382 00383 00384 00385 00386 00387 00388 00389 00390 00391 00392 00393 00394 00395 00396 00397 00398 00399 00400 00401 00402 00403 00404 00405 00406 00407 00408 00409 00410 00411 00412 00413 00414 00415 00416 00417 00418 00419 00420 00421 00422 00423 00424 00425 00426 00427 00428 00429 00430 00431 00432 00433 00434 00435 00436 00437 00438 00439 00440 00441 00442 00443 00444 00445 00446 00447 00448 00449 00450 00451 00452 00453 00454 00455 00456 00457 00458 00459 00460 00461 00462 00463 00464 00465 00466 00467 00468 00469 00470 00471 00472 00473 00474 00475 00476 00477 00478 00479 00480 00481 00482 00483 00484 00485 00486 00487 00488 00489 00490 00491 00492 00493 00494 00495 00496 00497 00498 00499 00500 00501 00502 00503 00504 00505 00506 00507 00508 00509 00510 00511 00512 00513 00514 00515 00516 00517 00518 00519 00520 00521 00522 00523 00524 00525 00526 00527 00528 00529 00530 00531 00532 00533 00534 00535 00536 00537 00538 00539 00540 00541 00542 00543 00544 00545 00546 00547 00548 00549 00550 00551 00552 00553 00554 00555 00556 00557 00558 00559 00560 00561 00562 00563 00564 00565 00566 00567 00568 00569 00570 00571 00572 00573 00574 00575 00576 00577 00578 00579 00580 00581 00582 00583 00584 00585 00586 00587 00588 00589 00590 00591 00592 00593 00594 00595 00596 00597 00598 00599 00600 00601 00602 00603 00604 00605 00606 00607 00608 00609 00610 00611 00612 00613 00614 00615 00616 00617 00618 00619 00620 00621 00622 00623 00624 00625 00626 00627 00628 00629 00630 00631 00632 00633 00634 00635 00636 00637 00638 00639 00640 00641 00642 00643 00644 00645 00646 00647 00648 00649 00650 00651 00652 00653 00654 00655 00656 00657 00658 00659 00660 00661 00662 00663 00664 00665 00666 00667 00668 00669 00670 00671 00672 00673 00674 00675 00676 00677 00678 00679 00680 00681 00682 00683 00684 00685 00686 00687 00688 00689 00690 00691 00692 00693 00694 00695 00696 00697 00698 00699 00700 00701 00702 00703 00704 00705 00706 00707 00708 00709 00710 00711 00712 00713 00714 00715 00716 00717 00718 00719 00720 00721 00722 00723 00724 00725 00726 00727 00728 00729 00730 00731 00732 00733 00734 00735 00736 00737 00738 00739 00740 00741 00742 00743 00744 00745 00746 00747 00748 00749 00750 00751 00752 00753 00754 00755 00756 00757 00758 00759 00760 00761 00762 00763 00764 00765 00766 00767 00768 00769 00770 00771 00772 00773 00774 00775 00776 00777 00778 00779 00780 00781 00782 00783 00784 00785 00786 00787 00788 00789 00790 00791 00792 00793 00794 00795 00796 00797 00798 00799 00800 00801 00802 00803 00804 00805 00806 00807 00808 00809 00810 00811 00812 00813 00814 00815 00816 00817 00818 00819 00820 00821 00822 00823 00824 00825 00826 00827 00828 00829 00830 00831 00832 00833 00834 00835 00836 00837 00838 00839 00840 00841 00842 00843 00844 00845 00846 00847 00848 00849 00850 00851 00852 00853 00854 00855 00856 00857 00858 00859 00860 00861 00862 00863 00864 00865 00866 00867 00868 00869 00870 00871 00872 00873 00874 00875 00876 00877 00878 00879 00880 00881 00882 00883 00884 00885 00886 00887 00888 00889 00890 00891 00892 00893 00894 00895 00896 00897 00898 00899 00900 00901 00902 00903 00904 00905 00906 00907 00908 00909 00910 00911 00912 00913 00914 00915 00916 00917 00918 00919 00920 00921 00922 00923 00924 00925 00926 00927 00928 00929 00930 00931 00932 00933 00934 00935 00936 00937 00938 00939 00940 00941 00942 00943 00944 00945 00946 00947 00948 00949 00950 00951 00952 00953 00954 00955 00956 00957 00958 00959 00960 00961 00962 00963 00964 00965 00966 00967 00968 00969 00970 00971 00972 00973 00974 00975 00976 00977 00978 00979 00980 00981 00982 00983 00984 00985 00986 00987 00988 00989 00990 00991 00992 00993 00994 00995 00996 00997 00998 00999 01000 01001 01002 01003 01004 01005 01006 01007 01008 01009 01010 01011 01012 01013 01014 01015 01016 01017 01018 |
/** * Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. */ /** * Base class for any type of settings that can be manipulated by the UI */ class Settings extends Object native abstract; /** The types of advertisement of settings to use */ enum EOnlineDataAdvertisementType { /** Don't advertise via the online service or QoS data */ ODAT_DontAdvertise, /** Advertise via the online service only */ ODAT_OnlineService, /** Advertise via the QoS data only */ ODAT_QoS }; /** * Structure used to represent a string setting that has a restricted and * localized set of value strings. For instance: * * GameType (id) Values = (0) Death Match, (1) Team Death Match, etc. * * This allows strings to be transmitted using only 8 bytes and each string * is correct for the destination language irrespective of sender's language */ struct native LocalizedStringSetting { /** The unique identifier for this localized string */ var int Id; /** The unique index into the list of localized strings */ var int ValueIndex; /** How this setting should be presented to requesting clients: online or QoS */ var EOnlineDataAdvertisementType AdvertisementType; }; /** The supported data types that can be stored in the union */ enum ESettingsDataType { /** Means the data in the OnlineData value fields should be ignored */ SDT_Empty, /** 32 bit integer goes in Value1 only*/ SDT_Int32, /** 64 bit integer stored in both value fields */ SDT_Int64, /** Double (8 byte) stored in both value fields */ SDT_Double, /** Unicode string pointer in Value2 with length in Value1 */ SDT_String, /** Float (4 byte) stored in Value1 fields */ SDT_Float, /** Binary data with count in Value1 and pointer in Value2 */ SDT_Blob, /** Date/time structure. Date in Value1 and time Value2 */ SDT_DateTime }; /** Structure to hold arbitrary data of a given type */ struct native SettingsData { /** Enum (byte) indicating the type of data held in the value fields */ var const ESettingsDataType Type; /** This is a union of value types and should never be used in script */ var const int Value1; /** * This is a union of value types and should never be used in script * NOTE: It's declared as a pointer for 64bit systems */ var const transient native pointer Value2{INT}; structcpptext { /** * Copies the data and sets the type * * @param InData the new data to assign */ void SetData(const FString& InData); /** * Copies the data and sets the type * * @param InData the new data to assign */ void SetData(const TCHAR* InData); /** * Copies the data and sets the type * * @param InData the new data to assign */ void SetData(INT InData); /** * Copies the data and sets the type to DateTime * * @param InData1 the first part to assign * @param InData2 the second part to assign */ void SetData(INT InData1,INT InData2); /** * Copies the data and sets the type * * @param InData the new data to assign */ void SetData(DOUBLE InData); /** * Copies the data and sets the type * * @param InData the new data to assign */ void SetData(FLOAT InData); /** * Copies the data and sets the type * * @param InData the new data to assign */ void SetData(const TArray<BYTE>& InData); /** * Copies the data and sets the type * * @param Size the length of the buffer to copy * @param InData the new data to assign */ void SetData(DWORD Size,const BYTE* InData); /** * Copies the data and sets the type * * @param InData the new data to assign */ void SetData(QWORD InData); /** * Copies the data after verifying the type * * @param OutData out value that receives the copied data */ void GetData(FString& OutData) const; /** * Copies the data after verifying the type * * @param OutData out value that receives the copied data */ void GetData(INT& OutData) const; /** * Copies the data after verifying the type * * @param OutData out value that receives the copied data */ void GetData(QWORD& OutData) const; /** * Copies the data after verifying the type * * @param OutData out value that receives the copied data */ void GetData(FLOAT& OutData) const; /** * Copies the data after verifying the type * * @param OutData out value that receives the copied data */ void GetData(TArray<BYTE>& OutData) const; /** * Copies the data after verifying the type. * NOTE: Performs a deep copy so you are repsonsible for freeing the data * * @param OutSize out value that receives the size of the copied data * @param OutData out value that receives the copied data */ void GetData(DWORD& OutSize,BYTE** OutData) const; /** * Copies the data into the two fields after verifying the type is DateTime * * @param InData1 the first part to assign * @param InData2 the second part to assign */ void GetData(INT& InData1,INT& InData2); /** * Increments the value by the specified amount * * @param IncBy the amount to increment by */ template<typename TYPE,ESettingsDataType ENUM_TYPE> FORCEINLINE void Increment(TYPE IncBy) { checkSlow(Type == SDT_Int32 || Type == SDT_Int64 || Type == SDT_Float || Type == SDT_Double); if (Type == ENUM_TYPE) { *(TYPE*)&Value1 += IncBy; } } /** * Decrements the value by the specified amount * * @param DecBy the amount to decrement by */ template<typename TYPE,ESettingsDataType ENUM_TYPE> FORCEINLINE void Decrement(TYPE DecBy) { checkSlow(Type == SDT_Int32 || Type == SDT_Int64 || Type == SDT_Float || Type == SDT_Double); if (Type == ENUM_TYPE) { *(TYPE*)&Value1 -= DecBy; } } /** * Cleans up the existing data and sets the type to ODT_Empty */ void CleanUp(void); /** Does nothing (no init version) */ FSettingsData(void) { } /** * Zeroes members */ FSettingsData(EEventParm) : Type(SDT_Empty), Value1(0), Value2(0) { } /** * Copy constructor. Copies the other into this object * * @param Other the other structure to copy */ FSettingsData(const FSettingsData& Other); /** * Assignment operator. Copies the other into this object * * @param Other the other structure to copy */ FSettingsData& operator=(const FSettingsData& Other); /** * Cleans up the data to prevent leaks */ ~FSettingsData(void) { CleanUp(); } /** * Converts the data into a string representation */ FString ToString(void) const; /** * Converts the string to the specified type of data for this setting * * @param NewValue the string value to convert * * @return TRUE if it was converted, FALSE otherwise */ UBOOL FromString(const FString& NewValue); /** * Copies the data after verifying the type * * @param OutData out value that receives the copied data */ void GetData(DOUBLE& OutData) const; } }; /** * Structure used to hold non-localized string data. Properties can be * arbitrary types. */ struct native SettingsProperty { /** The unique id for this property */ var int PropertyId; /** The data stored for the type */ var SettingsData Data; /** How this setting should be presented to requesting clients: online or QoS */ var EOnlineDataAdvertisementType AdvertisementType; structcpptext { /** Does nothing (no init version) */ FSettingsProperty(void) { } /** * Zeroes members */ FSettingsProperty(EEventParm) : PropertyId(0), Data(EC_EventParm), AdvertisementType(0) { } /** * Copy constructor. Copies the other into this object * * @param Other the other structure to copy */ FSettingsProperty(const FSettingsProperty& Other) { PropertyId = Other.PropertyId; // This will do a deep copy Data = Other.Data; AdvertisementType = Other.AdvertisementType; } /** * Assignment operator. Copies the other into this object * * @param Other the other structure to copy */ FSettingsProperty& operator=(const FSettingsProperty& Other) { if (&Other != this) { PropertyId = Other.PropertyId; // This will do a deep copy Data = Other.Data; AdvertisementType = Other.AdvertisementType; } return *this; } } }; /** Maps an Id value to a string */ struct native StringIdToStringMapping { /** Id for the given string */ var const int Id; /** Human readable form of the Id */ var const localized name Name; /** Whether this id is used to indicate a wildcard value or not */ var const bool bIsWildcard; }; /** Contains the meta information for a given context */ struct native LocalizedStringSettingMetaData { /** Id for the given string */ var const int Id; /** Human readable form of the Id */ var const name Name; /** Localized text used for list column headers */ var const localized string ColumnHeaderText; /** Holds the mappings of localized string setting values to their human readable form */ var const array<StringIdToStringMapping> ValueMappings; }; /** Maps an Id value to a string */ struct native IdToStringMapping { /** Id for the given string */ var const int Id; /** Human readable form of the Id */ var const localized name Name; }; /** Used to indicate how the data should be retrieved for the UI */ enum EPropertyValueMappingType { /** The value is presented "as is" without mapping/manipulation */ PVMT_RawValue, /** The property has a set of predefined values that are the only ones to choose from */ PVMT_PredefinedValues, /** The property must exist within the min/max range specified */ PVMT_Ranged, /** The property is mapped using id/name pairs */ PVMT_IdMapped }; /** Contains the meta information needed to validate property data */ struct native SettingsPropertyPropertyMetaData { /** Id for the given string */ var const int Id; /** Human readable form of the Id */ var const name Name; /** Localized text used for list column headers */ var const localized string ColumnHeaderText; /** Whether the value is ID mapped or should be string-ized */ var const EPropertyValueMappingType MappingType; /** Holds the mappings of value IDs to their human readable form */ var const array<IdToStringMapping> ValueMappings; /** Holds a set of predefined values for a property when freeform editing isn't desired */ var const array<SettingsData> PredefinedValues; /** The min value for this property */ var const float MinVal; /** The max value for this property */ var const float MaxVal; /** The amount that this range can be incremented/decremented by */ var const float RangeIncrement; }; /** The various localized string settings to use with the session */ var array<LocalizedStringSetting> LocalizedSettings; /** The properties used by the derived settings class */ var array<SettingsProperty> Properties; /** Used to map a localized string setting to a human readable string */ var array<LocalizedStringSettingMetaData> LocalizedSettingsMappings; /** Used to map a property to a human readable string and validate its range */ var array<SettingsPropertyPropertyMetaData> PropertyMappings; // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) /** * Static function for setting members of the SettingsData union. * * @param Data the data structure to set the fields of * @param InString the string data to set in the union */ static native function SetSettingsDataString(out SettingsData Data,string InString); /** * Static function for setting members of the SettingsData union * * @param Data the data structure to set the fields of * @param InFloat the float data to set in the union */ static native function SetSettingsDataFloat(out SettingsData Data,float InFloat); /** * Static function for setting members of the SettingsData union * * @param Data the data structure to set the fields of * @param InInt the 32 bit integer data to set in the union */ static native function SetSettingsDataInt(out SettingsData Data,int InInt); /** * Static function for setting members of the SettingsData union * * @param Data the data structure to set the fields of * @param InInt1 first half of the data to set * @param InInt2 second half of the data to set */ static native function SetSettingsDataDateTime(out SettingsData Data,int InInt1,int InInt2); /** * Static function for setting members of the SettingsData union * * @param Data the data structure to set the fields of * @param InBlob the 8 bytes to copy into the union */ static native function SetSettingsDataBlob(out SettingsData Data,out array<byte> InBlob); /** * Static function for setting members of the SettingsData union * * @param Data the data structure to set the fields of * @param Data2Copy the SettingsData object to copy */ static native function SetSettingsData(out SettingsData Data,out SettingsData Data2Copy); /** * Empties an SettingsData structure * * @param Data the data structure to set the fields of */ static native function EmptySettingsData(out SettingsData Data); /** * Static function for copying data out of the SettingsData union. * * @param Data the data structure to copy the data from */ static native function string GetSettingsDataString(out SettingsData Data); /** * Static function for copying data out of the SettingsData union * * @param Data the data structure to copy the data from */ static native function float GetSettingsDataFloat(out SettingsData Data); /** * Static function for copying data out of the SettingsData union * * @param Data the data structure to copy the data from */ static native function int GetSettingsDataInt(out SettingsData Data); /** * Static function for copying data out the SettingsData union * * @param Data the data structure to copy the data from * @param OutBlob the buffer to copy the data into */ static native function GetSettingsDataBlob(out SettingsData Data,out array<byte> OutBlob); /** * Static function for getting members of the SettingsData union * * @param Data the data structure to get the fields of * @param OutInt1 first half of the data to get * @param OutInt2 second half of the data to get */ static native function GetSettingsDataDateTime(out SettingsData Data,out int OutInt1,out int OutInt2); /** * Searches the localized string setting array for the matching id and sets the value * * @param StringSettingId the string setting to set the value for * @param ValueIndex the value of the string setting * @param bShouldAutoAdd whether to add the context if it is missing */ native function SetStringSettingValue(int StringSettingId,int ValueIndex,bool bShouldAutoAdd); /** * Searches the localized string setting array for the matching id and returns its value * * @param StringSettingId the string setting to find the value of * @param ValueIndex the out value that is set when found * * @return true if found, false otherwise */ native function bool GetStringSettingValue(int StringSettingId,out int ValueIndex); /** * Searches the localized string setting array for the matching id and * returns the list of possible values * * @param StringSettingId the string setting to find the value of * @param Values the out value that is a list of value names and their ids * * @return true if found, false otherwise */ native function bool GetStringSettingValueNames(int StringSettingId,out array<IdToStringMapping> Values); /** * Searches the localized string setting array for the matching name and sets the value * * @param StringSettingName the setting name to set the value for * @param ValueIndex the value of the string setting * @param bShouldAutoAdd whether to add the string setting if it is missing */ native function SetStringSettingValueByName(name StringSettingName,int ValueIndex,bool bShouldAutoAdd); /** * Searches the localized string setting array for the matching name and returns its value * * @param StringSettingName the setting name to find the value of * @param ValueIndex the out value that is set when found * * @return true if found, false otherwise */ native function bool GetStringSettingValueByName(name StringSettingName,out int ValueIndex); /** * Searches the context array for the matching string setting name and returns the id * * @param StringSettingName the name of the string setting being searched for * @param StringSettingId the id of the context that matches the name * * @return true if the seting was found, false otherwise */ native function bool GetStringSettingId(name StringSettingName,out int StringSettingId); /** * Finds the human readable name for the localized string setting * * @param StringSettingId the id to look up in the mappings table * * @return the name of the string setting that matches the id or NAME_None if not found */ native function name GetStringSettingName(int StringSettingId); /** * Finds the localized column header text for the string setting * * @param StringSettingId the id to look up in the mappings table * * @return the string to use as the list column header for the string setting that matches the id, or an empty string if not found. */ native function string GetStringSettingColumnHeader( int StringSettingId ); /** * Determines if the value for the specified setting is a wildcard option * * @param StringSettingId the id to check for being a wildcard * * @return true if the current value is a wildcard, false otherwise */ native function bool IsWildcardStringSetting(int StringSettingId); /** * Finds the human readable name for a string setting's value. Searches the * string settings mappings for the specifc string setting and then searches * the set of values for the specific value index and returns that value's * human readable name * * @param StringSettingId the id to look up in the mappings table * @param ValueIndex the value index to find the string value of * * @return the name of the string setting value that matches the id & index or NAME_None if not found */ native function name GetStringSettingValueName(int StringSettingId,int ValueIndex); /** * Finds the human readable name for a string setting's value. Searches the * string settings mappings for the specifc string setting and then searches * the set of values for the specific value index and returns that value's * human readable name * * @param StringSettingName the name of the string setting to find the string value of * * @return the name of the string setting value that matches the name or NAME_None if not found */ native function name GetStringSettingValueNameByName(name StringSettingName); /** * Searches for the string setting by name and sets the value index to the * value contained in the string setting meta data * * @param StringSettingName the name of the string setting to find * @param NewValue the string value to use * * @return true if the string setting was found and the value was set, false otherwise */ native function bool SetStringSettingValueFromStringByName(name StringSettingName,const out string NewValue); /** * Searches the property array for the matching property and returns the id * * @param PropertyName the name of the property being searched for * @param PropertyId the id of the context that matches the name * * @return true if the property was found, false otherwise */ native function bool GetPropertyId(name PropertyName,out int PropertyId); /** * Finds the human readable name for the property * * @param PropertyId the id to look up in the mappings table * * @return the name of the property that matches the id or NAME_None if not found */ native function name GetPropertyName(int PropertyId); /** * Finds the localized column header text for the property * * @param PropertyId the id to look up in the mappings table * * @return the string to use as the list column header for the property that matches the id, or an empty string if not found. */ native function string GetPropertyColumnHeader( int PropertyId ); /** * Converts a property to a string. Searches by id * * @param PropertyId the id to look up in the mappings table * * @return the string form of the property value or an empty string if invalid/missing */ native function string GetPropertyAsString(int PropertyId); /** * Converts a property to a string. Searches by name * * @param PropertyName the name of the property to find * * @return the string form of the property value or an empty string if invalid/missing */ native function string GetPropertyAsStringByName(name PropertyName); /** * Searches for the property by name and sets the property to the value contained * in the string * * @param PropertyName the name of the property to find * @param NewValue the string value to use * * @return true if the property was found and the value was set, false otherwise */ native function bool SetPropertyFromStringByName(name PropertyName,const out string NewValue); /** * Sets a property of type SDT_Float to the value specified. Does nothing * if the property is not of the right type. * * @param PropertyId the property to change the value of * @param Value the new value to assign */ native function SetFloatProperty(int PropertyId,float Value); /** * Reads a property of type SDT_Float into the value specified. Does nothing * if the property is not of the right type. * * @param PropertyId the property to read the value of * @param Value the out value containing the property's value * * @return true if found and is the right type, false otherwise */ native function bool GetFloatProperty(int PropertyId,out float Value); /** * Sets a property of type SDT_Int32 to the value specified. Does nothing * if the property is not of the right type. * * @param PropertyId the property to change the value of * @param Value the new value to assign */ native function SetIntProperty(int PropertyId,int Value); /** * Reads a property of type SDT_Int32 into the value specified. Does nothing * if the property is not of the right type. * * @param PropertyId the property to change the value of * @param Value the out value containing the property's value * * @return true if found and is the right type, false otherwise */ native function bool GetIntProperty(int PropertyId,out int Value); /** * Sets a property of type SDT_String to the value specified. Does nothing * if the property is not of the right type. * * @param PropertyId the property to change the value of * @param Value the new value to assign */ native function SetStringProperty(int PropertyId,string Value); /** * Reads a property of type SDT_String into the value specified. Does nothing * if the property is not of the right type. * * @param PropertyId the property to change the value of * @param Value the out value containing the property's value * * @return true if found and is the right type, false otherwise */ native function bool GetStringProperty(int PropertyId,out string Value); /** * Determines the property type for the specified property id * * @param PropertyId the property to change the value of * * @return the type of property, or SDT_Empty if not found */ native function ESettingsDataType GetPropertyType(int PropertyId); /** * Using the specified array, updates the matching settings to the new values * in that array. Optionally, it will add settings that aren't currently part * of this object. * * @param Settings the list of settings to update * @param bShouldAddIfMissing whether to automatically add the setting if missing */ native function UpdateStringSettings(const out array<LocalizedStringSetting> Settings,bool bShouldAddIfMissing = true); /** * Using the specified array, updates the matching properties to the new values * in that array. Optionally, it will add properties that aren't currently part * of this object. * * @param Props the list of properties to update * @param bShouldAddIfMissing whether to automatically add the property if missing */ native function UpdateProperties(const out array<SettingsProperty> Props,bool bShouldAddIfMissing = true); /** * Determines if a given property is present for this object * * @param PropertyId the ID to check on * * @return TRUE if the property is part of this object, FALSE otherwise */ native function bool HasProperty(int PropertyId); /** * Determines if a given localized string setting is present for this object * * @param SettingId the ID to check on * * @return TRUE if the setting is part of this object, FALSE otherwise */ native function bool HasStringSetting(int SettingId); /** * Determines the mapping type for the specified property * * @param PropertyId the ID to get the mapping type for * @param OutType the out var the value is placed in * * @return TRUE if found, FALSE otherwise */ native function bool GetPropertyMappingType(int PropertyId,out EPropertyValueMappingType OutType); /** * Determines the min and max values of a property that is clamped to a range * * @param PropertyId the ID to get the mapping type for * @param OutMinValue the out var the min value is placed in * @param OutMaxValue the out var the max value is placed in * @param RangeIncrement the amount the range can be adjusted by the UI in any single update * @param bFormatAsInt whether the range's value should be treated as an int. * * @return TRUE if found and is a range property, FALSE otherwise */ native function bool GetPropertyRange(int PropertyId,out float OutMinValue,out float OutMaxValue,out float RangeIncrement,out byte bFormatAsInt); /** * Sets the value of a ranged property, clamping to the min/max values * * @param PropertyId the ID of the property to set * @param NewValue the new value to apply to the * * @return TRUE if found and is a range property, FALSE otherwise */ native function bool SetRangedPropertyValue(int PropertyId,float NewValue); /** * Gets the value of a ranged property * * @param PropertyId the ID to get the value of * @param OutValue the out var that receives the value * * @return TRUE if found and is a range property, FALSE otherwise */ native function bool GetRangedPropertyValue(int PropertyId,out float OutValue); /** * Scans the properties for the ones that need to be set via QoS data * * @param QoSProps the out array holding the list of properties to advertise via QoS */ native function GetQoSAdvertisedProperties(out array<SettingsProperty> QoSProps); /** * Scans the string settings for the ones that need to be set via QoS data * * @param QoSSettings the out array holding the list of settings to advertise via QoS */ native function GetQoSAdvertisedStringSettings(out array<LocalizedStringSetting> QoSSettings); /** * Appends databindings to the URL. * * @param OutURL String to append bindings to. */ native function AppendDataBindingsToURL(out string URL); /** * Appends properties to the URL. * * @param OutURL String to append properties to. */ native function AppendPropertiesToURL(out string URL); /** * Appends contexts to the URL. * * @param OutURL String to append contexts to. */ native function AppendContextsToURL(out string URL); /** * Builds an URL out of the string settings and properties * * @param URL the string to populate */ native function BuildURL(out string URL); /** * Updates the game settings object from parameters passed on the URL * * @param URL the URL to parse for settings */ native function UpdateFromURL(const out string URL, GameInfo Game); /** * Outputs the names of properties in the class which are databinding, and which can be manipulated using GetDataBindingValue and SetDataBindingValue. * Property types which are not returned are: Object, Delegate, Array and Struct */ native final function GetDataBindingProperties(out array<name> DataBindingProperties); /** * Outputs the value of the specified databinding property, returning True if successful * NOTE: This has the same restrictions on property types as 'GetDataBindingProperties' * @param bIgnoreDefaults If true, then the function returns false and does not output a value if the property is still at it's default value */ native final function bool GetDataBindingValue(name Property, out string Value, optional bool bIgnoreDefaults); /** * Sets the value of the specified databinding property to the specified input value, returning True if successful * NOTE: This has the same restrictions on property types as 'GetDataBindingProperties' */ native final function bool SetDataBindingValue(name Property, string Value); defaultproperties { Name="Default__Settings" ObjectArchetype=Object'Core.Default__Object' } |
Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
previous class next class | frames no frames |