PlayerIO

The fastest way to build online games without breaking a sweat.

Multiplayer Reference

Multiplayer  class documentationClass VaultItem

Namespace: PlayerIO.GameLibrary
Language: C# / .NET

Represents information about an item in a user's Vault.

The methods and properties in a VaultItem are very simliar to those of a DatabaseObject, except that it's read-only, and that there are some extra properties regarding the purchase.

Properties

 
public int
Count  [read-only]

Returns the number of properties on this object

public string
Id  [read-only]

The unique id of this particular vault item in the users vault

public string
ItemKey  [read-only]

The key of the underlying item in the PayVaultItems BigDB table

public ICollection<string>
Properties  [read-only]

Get the names of all properties on this object

public DateTime
PurchaseDate  [read-only]

The time when the vault item was originally purchased

Methods

 
public bool
Contains (string propertyExpression)

Returns true if the given property exists on this object

public DatabaseArray
GetArray (string propertyExpression)

Get the given array property

public bool
GetBool (string propertyExpression, bool defaultValue)

Get the given bool property, falling back to the given default value if the bool property does not exist

public bool
GetBool (string propertyExpression)

Get the given bool property

public Byte[]
GetBytes (string propertyExpression, Byte[] defaultValue)

Get the given byte array property, falling back to the given default value if the byte array property does not exist

public Byte[]
GetBytes (string propertyExpression)

Get the given byte array property

public DateTime
GetDateTime (string propertyExpression, DateTime defaultValue)

Get the given datetime property, falling back to the given default value if the datetime property does not exist

public DateTime
GetDateTime (string propertyExpression)

Get the given datetime property

public Double
GetDouble (string propertyExpression)

Get the given double property

public Double
GetDouble (string propertyExpression, Double defaultValue)

Get the given double property, falling back to the given default value if the double property does not exist

public Single
GetFloat (string propertyExpression, Single defaultValue)

Get the given float property, falling back to the given default value if the float property does not exist

public Single
GetFloat (string propertyExpression)

Get the given float property

public int
GetInt (string propertyExpression)

Get the given int property

public int
GetInt (string propertyExpression, int defaultValue)

Get the given int property, falling back to the given default value if the int property does not exist

public Int64
GetLong (string propertyExpression, Int64 defaultValue)

Get the given long property, falling back to the given default value if the long property does not exist

public Int64
GetLong (string propertyExpression)

Get the given long property

public DatabaseObject
GetObject (string propertyExpression)

Get the given object property

public string
GetString (string propertyExpression, string defaultValue)

Get the given string property, falling back to the given default value if the string property does not exist

public string
GetString (string propertyExpression)

Get the given string property

public uint
GetUInt (string propertyExpression)

Get the given uint property

public uint
GetUInt (string propertyExpression, uint defaultValue)

Get the given uint property, falling back to the given default value if the uint property does not exist

public object
GetValue (string propertyExpression)

Get the given property as an object

VaultItem.Count

public int
Count  [read-only]

Returns the number of properties on this object

VaultItem.Id

public string
Id  [read-only]

The unique id of this particular vault item in the users vault

VaultItem.ItemKey

public string
ItemKey  [read-only]

The key of the underlying item in the PayVaultItems BigDB table

VaultItem.Properties

public ICollection<string>
Properties  [read-only]

Get the names of all properties on this object

VaultItem.PurchaseDate

public DateTime
PurchaseDate  [read-only]

The time when the vault item was originally purchased

VaultItem.Contains

public bool
Contains (string propertyExpression)

Returns true if the given property exists on this object

Arguments

string propertyExpression

VaultItem.GetArray

public DatabaseArray
GetArray (string propertyExpression)

Get the given array property

Arguments

string propertyExpression

VaultItem.GetBool

public bool
GetBool (string propertyExpression, bool defaultValue)

Get the given bool property, falling back to the given default value if the bool property does not exist

Arguments

string propertyExpression
bool defaultValue

VaultItem.GetBool

public bool
GetBool (string propertyExpression)

Get the given bool property

Arguments

string propertyExpression

VaultItem.GetBytes

public Byte[]
GetBytes (string propertyExpression, Byte[] defaultValue)

Get the given byte array property, falling back to the given default value if the byte array property does not exist

Arguments

string propertyExpression
Byte[] defaultValue

VaultItem.GetBytes

public Byte[]
GetBytes (string propertyExpression)

Get the given byte array property

Arguments

string propertyExpression

VaultItem.GetDateTime

public DateTime
GetDateTime (string propertyExpression, DateTime defaultValue)

Get the given datetime property, falling back to the given default value if the datetime property does not exist

Arguments

string propertyExpression
DateTime defaultValue

VaultItem.GetDateTime

public DateTime
GetDateTime (string propertyExpression)

Get the given datetime property

Arguments

string propertyExpression

VaultItem.GetDouble

public Double
GetDouble (string propertyExpression)

Get the given double property

Arguments

string propertyExpression

VaultItem.GetDouble

public Double
GetDouble (string propertyExpression, Double defaultValue)

Get the given double property, falling back to the given default value if the double property does not exist

Arguments

string propertyExpression
Double defaultValue

VaultItem.GetFloat

public Single
GetFloat (string propertyExpression, Single defaultValue)

Get the given float property, falling back to the given default value if the float property does not exist

Arguments

string propertyExpression
Single defaultValue

VaultItem.GetFloat

public Single
GetFloat (string propertyExpression)

Get the given float property

Arguments

string propertyExpression

VaultItem.GetInt

public int
GetInt (string propertyExpression)

Get the given int property

Arguments

string propertyExpression

VaultItem.GetInt

public int
GetInt (string propertyExpression, int defaultValue)

Get the given int property, falling back to the given default value if the int property does not exist

Arguments

string propertyExpression
int defaultValue

VaultItem.GetLong

public Int64
GetLong (string propertyExpression, Int64 defaultValue)

Get the given long property, falling back to the given default value if the long property does not exist

Arguments

string propertyExpression
Int64 defaultValue

VaultItem.GetLong

public Int64
GetLong (string propertyExpression)

Get the given long property

Arguments

string propertyExpression

VaultItem.GetObject

public DatabaseObject
GetObject (string propertyExpression)

Get the given object property

Arguments

string propertyExpression

VaultItem.GetString

public string
GetString (string propertyExpression, string defaultValue)

Get the given string property, falling back to the given default value if the string property does not exist

Arguments

string propertyExpression
string defaultValue

VaultItem.GetString

public string
GetString (string propertyExpression)

Get the given string property

Arguments

string propertyExpression

VaultItem.GetUInt

public uint
GetUInt (string propertyExpression)

Get the given uint property

Arguments

string propertyExpression

VaultItem.GetUInt

public uint
GetUInt (string propertyExpression, uint defaultValue)

Get the given uint property, falling back to the given default value if the uint property does not exist

Arguments

string propertyExpression
uint defaultValue

VaultItem.GetValue

public object
GetValue (string propertyExpression)

Get the given property as an object

Arguments

string propertyExpression