LootLocker Unity SDK 8.0.0
Game backend SDK for Unity
Loading...
Searching...
No Matches
LootLocker.Requests.LootLockerMetadataEntry Class Reference

/summary> More...

Inheritance diagram for LootLocker.Requests.LootLockerMetadataEntry:

Public Member Functions

bool TryGetValueAsString (out string output)
 Get the value as a String.
 
bool TryGetValueAsDouble (out double output)
 Get the value as a double.
 
bool TryGetValueAsInteger (out int output)
 Get the value as an integer.
 
bool TryGetValueAsBool (out bool output)
 Get the value as a boolean.
 
bool TryGetValueAsType< T > (out T output)
 Get the value as the specified type.
 
bool TryGetValueAsJson (out Dictionary< string, object > output)
 Get the value as a Json Object (a dictionary of string keys to object values).
 
bool TryGetValueAsJsonArray (out object[] output)
 Get the value as a Json Array.
 
bool TryGetValueAsBase64 (out LootLockerMetadataBase64Value output)
 Get the value as a LootLockerMetadataBase64Value object.
 

Properties

object value [get, set]
 The value of the metadata in base object format (unparsed).
 
string key [get, set]
 The metadata key /summary>
 
LootLockerMetadataTypes type [get, set]
 The type of value this metadata contains.
 
string[] tags [get, set]
 List of tags applied to this metadata entry /summary>
 
string[] access [get, set]
 The access level set for this metadata entry.
 

Detailed Description

/summary>

Member Function Documentation

◆ TryGetValueAsBase64()

bool LootLocker.Requests.LootLockerMetadataEntry.TryGetValueAsBase64 ( out LootLockerMetadataBase64Value  output)
inline

Get the value as a LootLockerMetadataBase64Value object.

Returns true if value could be parsed in which case output contains the FLootLockerMetadataBase64Value, returns false if parsing failed. /summary>

◆ TryGetValueAsBool()

bool LootLocker.Requests.LootLockerMetadataEntry.TryGetValueAsBool ( out bool  output)
inline

Get the value as a boolean.

Returns true if value could be parsed in which case output contains the value in boolean format, returns false if parsing failed which can happen if the string is not a convertible to a boolean. /summary>

◆ TryGetValueAsDouble()

bool LootLocker.Requests.LootLockerMetadataEntry.TryGetValueAsDouble ( out double  output)
inline

Get the value as a double.

Returns true if value could be parsed in which case output contains the value in double format, returns false if parsing failed which can happen if the value is not numeric, the conversion under or overflows, or the string value precision is larger than can be dealt within a double. /summary>

◆ TryGetValueAsInteger()

bool LootLocker.Requests.LootLockerMetadataEntry.TryGetValueAsInteger ( out int  output)
inline

Get the value as an integer.

Returns true if value could be parsed in which case output contains the value in integer format, returns false if parsing failed which can happen if the value is not numeric or the conversion under or overflows /summary>

◆ TryGetValueAsJson()

bool LootLocker.Requests.LootLockerMetadataEntry.TryGetValueAsJson ( out Dictionary< string, object >  output)
inline

Get the value as a Json Object (a dictionary of string keys to object values).

Returns true if value could be parsed in which case output contains the value in Json Object format, returns false if parsing failed which can happen if the value is not a valid json object string. /summary>

◆ TryGetValueAsJsonArray()

bool LootLocker.Requests.LootLockerMetadataEntry.TryGetValueAsJsonArray ( out object[]  output)
inline

Get the value as a Json Array.

Returns true if value could be parsed in which case output contains the value in Json Array format, returns false if parsing failed which can happen if the value is not a valid json array string. /summary>

◆ TryGetValueAsString()

bool LootLocker.Requests.LootLockerMetadataEntry.TryGetValueAsString ( out string  output)
inline

Get the value as a String.

Returns true if value could be parsed in which case output contains the value in string format, returns false if parsing failed. /summary>

◆ TryGetValueAsType< T >()

bool LootLocker.Requests.LootLockerMetadataEntry.TryGetValueAsType< T > ( out T  output)
inline

Get the value as the specified type.

Returns true if value could be parsed in which case output contains the parsed object, returns false if parsing failed which can happen if the value is not a valid json object string convertible to the specified object. /summary>

Property Documentation

◆ access

string [] LootLocker.Requests.LootLockerMetadataEntry.access
getset

The access level set for this metadata entry.

Valid values are game_api.read, game_api.write and player.read (only applicable for player metadata and means that the metadata entry is readable for players except the owner), though no values are required. Note that different sources can allow or disallow a subset of these values.

◆ type

LootLockerMetadataTypes LootLocker.Requests.LootLockerMetadataEntry.type
getset

The type of value this metadata contains.

Use this to know how to parse the value. /summary>

◆ value

object LootLocker.Requests.LootLockerMetadataEntry.value
getset

The value of the metadata in base object format (unparsed).

To use this as the type specified by the Type field, parse it using the corresponding TryGetValueAs<Type> method in C++ or using the LootLockerMetadataValueParser node in Blueprints. /summary>