Access to script storage. More...

Inheritance diagram for IScriptStorage:

abstract void	SetItem (string key, string value)
	Stores a value. More...

abstract void	SetItem (string key, int value)
	Stores a value. More...

abstract void	SetItem (string key, bool value)
	Stores a value. More...

abstract void	SetItem (string key, float value)
	Stores a value. More...

abstract void	SetItem (string key, long value)
	Stores a value. More...

abstract void	SetItem (string key, byte value)
	Stores a value. More...

abstract void	SetItem (string key, string[] value)
	Stores a value. More...

abstract void	SetItem (string key, int[] value)
	Stores a value. More...

abstract void	SetItem (string key, bool[] value)
	Stores a value. More...

abstract void	SetItem (string key, float[] value)
	Stores a value. More...

abstract void	SetItem (string key, long[] value)
	Stores a value. More...

abstract void	SetItem (string key, byte[] value)
	Stores a value. More...

abstract object	GetItem (string key)
	Gets a value. More...

abstract bool	TryGetItem (string key, out object value)
	Gets a value. More...

abstract bool	TryGetItemString (string key, out string value)
	Gets a value. More...

abstract bool	TryGetItemInt (string key, out int value)
	Gets a value. More...

abstract bool	TryGetItemBool (string key, out bool value)
	Gets a value. More...

abstract bool	TryGetItemFloat (string key, out float value)
	Gets a value. More...

abstract bool	TryGetItemLong (string key, out long value)
	Gets a value. More...

abstract bool	TryGetItemByte (string key, out byte value)
	Gets a value. More...

abstract bool	TryGetItemStringArr (string key, out string[] value)
	Gets a value. More...

abstract bool	TryGetItemIntArr (string key, out int[] value)
	Gets a value. More...

abstract bool	TryGetItemBoolArr (string key, out bool[] value)
	Gets a value. More...

abstract bool	TryGetItemFloatArr (string key, out float[] value)
	Gets a value. More...

abstract bool	TryGetItemLongArr (string key, out long[] value)
	Gets a value. More...

abstract bool	TryGetItemByteArr (string key, out byte[] value)
	Gets a value. More...

abstract bool	ContainsKey (string key)
	Checks if storage contains the key. More...

abstract bool	ContainsKeyValue (string key, string value)
	Checks if storage contains the key-value. More...

abstract bool	ContainsKeyValue (string key, int value)
	Checks if storage contains the key-value. More...

abstract bool	ContainsKeyValue (string key, bool value)
	Checks if storage contains the key-value. More...

abstract bool	ContainsKeyValue (string key, float value)
	Checks if storage contains the key-value. More...

abstract bool	ContainsKeyValue (string key, long value)
	Checks if storage contains the key-value. More...

abstract bool	ContainsKeyValue (string key, byte value)
	Checks if storage contains the key-value. More...

abstract bool	ContainsKeyValue (string key, string[] value)
	Checks if storage contains the key-value. More...

abstract bool	ContainsKeyValue (string key, int[] value)
	Checks if storage contains the key-value. More...

abstract bool	ContainsKeyValue (string key, bool[] value)
	Checks if storage contains the key-value. More...

abstract bool	ContainsKeyValue (string key, float[] value)
	Checks if storage contains the key-value. More...

abstract bool	ContainsKeyValue (string key, long[] value)
	Checks if storage contains the key-value. More...

abstract bool	ContainsKeyValue (string key, byte[] value)
	Checks if storage contains the key-value. More...

abstract string[]	GetKeys ()
	Gets all current keys registered with a value. More...

abstract bool	RemoveItem (string key)
	Removes an item from storage. More...

abstract void	Clear ()
	Clears all current keys in the storage. More...

abstract bool	RemoveNullValues ()
	Removes all key-value pairs where the value is null. More...

abstract void	WriteToConsole ()
	Writes the current storage data as to the output window in the map editor. For debugging only. More...

abstract bool	HasData ()
	Gets if any key-value pair exist. More...

Detailed Description

Access to script storage.

Member Function Documentation

◆ Clear()

abstract void Clear ( )

pure virtual

Clears all current keys in the storage.

◆ ContainsKey()

abstract bool ContainsKey ( string key )

pure virtual

Checks if storage contains the key.

Parameters

key Key

◆ ContainsKeyValue() [1/12]

abstract bool ContainsKeyValue	(	string	key,
		bool	value
	)

pure virtual

Checks if storage contains the key-value.

Parameters

key	Key
value	Value

Returns: True if the item is in storage.

◆ ContainsKeyValue() [2/12]

abstract bool ContainsKeyValue	(	string	key,
		bool[]	value
	)

pure virtual

Checks if storage contains the key-value.

Parameters

key	Key
value	Value

Returns: True if the item is in storage.

◆ ContainsKeyValue() [3/12]

abstract bool ContainsKeyValue	(	string	key,
		byte	value
	)

pure virtual

Checks if storage contains the key-value.

Parameters

key	Key
value	Value

Returns: True if the item is in storage.

◆ ContainsKeyValue() [4/12]

abstract bool ContainsKeyValue	(	string	key,
		byte[]	value
	)

pure virtual

Checks if storage contains the key-value.

Parameters

key	Key
value	Value

Returns: True if the item is in storage.

◆ ContainsKeyValue() [5/12]

abstract bool ContainsKeyValue	(	string	key,
		float	value
	)

pure virtual

Checks if storage contains the key-value.

Parameters

key	Key
value	Value

Returns: True if the item is in storage.

◆ ContainsKeyValue() [6/12]

abstract bool ContainsKeyValue	(	string	key,
		float[]	value
	)

pure virtual

Checks if storage contains the key-value.

Parameters

key	Key
value	Value

Returns: True if the item is in storage.

◆ ContainsKeyValue() [7/12]

abstract bool ContainsKeyValue	(	string	key,
		int	value
	)

pure virtual

Checks if storage contains the key-value.

Parameters

key	Key
value	Value

Returns: True if the item is in storage.

◆ ContainsKeyValue() [8/12]

abstract bool ContainsKeyValue	(	string	key,
		int[]	value
	)

pure virtual

Checks if storage contains the key-value.

Parameters

key	Key
value	Value

Returns: True if the item is in storage.

◆ ContainsKeyValue() [9/12]

abstract bool ContainsKeyValue	(	string	key,
		long	value
	)

pure virtual

Checks if storage contains the key-value.

Parameters

key	Key
value	Value

Returns: True if the item is in storage.

◆ ContainsKeyValue() [10/12]

abstract bool ContainsKeyValue	(	string	key,
		long[]	value
	)

pure virtual

Checks if storage contains the key-value.

Parameters

key	Key
value	Value

Returns: True if the item is in storage.

◆ ContainsKeyValue() [11/12]

abstract bool ContainsKeyValue	(	string	key,
		string	value
	)

pure virtual

Checks if storage contains the key-value.

Parameters

key	Key
value	Value

Returns: True if the item is in storage.

◆ ContainsKeyValue() [12/12]

abstract bool ContainsKeyValue	(	string	key,
		string[]	value
	)

pure virtual

Checks if storage contains the key-value.

Parameters

key	Key
value	Value

Returns: True if the item is in storage.

◆ GetItem()

abstract object GetItem ( string key )

pure virtual

Gets a value.

Parameters

key Key

◆ GetKeys()

abstract string [] GetKeys ( )

pure virtual

Gets all current keys registered with a value.

Returns: All keys

◆ HasData()

abstract bool HasData ( )

pure virtual

Gets if any key-value pair exist.

Returns: true if any key-value pair exist

◆ RemoveItem()

abstract bool RemoveItem ( string key )

pure virtual

Removes an item from storage.

Parameters

key Key

Returns: True if the item existed in the storage.

◆ RemoveNullValues()

abstract bool RemoveNullValues ( )

pure virtual

Removes all key-value pairs where the value is null.

Returns: true if any null values where removed.

◆ SetItem() [1/12]

abstract void SetItem	(	string	key,
		bool	value
	)

pure virtual

Stores a value.

Parameters

key	Key
value	Value

◆ SetItem() [2/12]

abstract void SetItem	(	string	key,
		bool[]	value
	)

pure virtual

Stores a value.

Parameters

key	Key
value	Value

◆ SetItem() [3/12]

abstract void SetItem	(	string	key,
		byte	value
	)

pure virtual

Stores a value.

Parameters

key	Key
value	Value

◆ SetItem() [4/12]

abstract void SetItem	(	string	key,
		byte[]	value
	)

pure virtual

Stores a value.

Parameters

key	Key
value	Value

◆ SetItem() [5/12]

abstract void SetItem	(	string	key,
		float	value
	)

pure virtual

Stores a value.

Parameters

key	Key
value	Value

◆ SetItem() [6/12]

abstract void SetItem	(	string	key,
		float[]	value
	)

pure virtual

Stores a value.

Parameters

key	Key
value	Value

◆ SetItem() [7/12]

abstract void SetItem	(	string	key,
		int	value
	)

pure virtual

Stores a value.

Parameters

key	Key
value	Value

◆ SetItem() [8/12]

abstract void SetItem	(	string	key,
		int[]	value
	)

pure virtual

Stores a value.

Parameters

key	Key
value	Value

◆ SetItem() [9/12]

abstract void SetItem	(	string	key,
		long	value
	)

pure virtual

Stores a value.

Parameters

key	Key
value	Value

◆ SetItem() [10/12]

abstract void SetItem	(	string	key,
		long[]	value
	)

pure virtual

Stores a value.

Parameters

key	Key
value	Value

◆ SetItem() [11/12]

abstract void SetItem	(	string	key,
		string	value
	)

pure virtual

Stores a value.

Parameters

key	Key
value	Value

◆ SetItem() [12/12]

abstract void SetItem	(	string	key,
		string[]	value
	)

pure virtual

Stores a value.

Parameters

key	Key
value	Value

◆ TryGetItem()

abstract bool TryGetItem	(	string	key,
		out object	value
	)

pure virtual

Gets a value.

Parameters

key	Key
value	Value

Returns: True if the item was found in storage.

◆ TryGetItemBool()

abstract bool TryGetItemBool	(	string	key,
		out bool	value
	)

pure virtual

Gets a value.

Parameters

key	Key
value	Value

Returns: True if the item was found in storage.

◆ TryGetItemBoolArr()

abstract bool TryGetItemBoolArr	(	string	key,
		out bool[]	value
	)

pure virtual

Gets a value.

Parameters

key	Key
value	Value

Returns: True if the item was found in storage.

◆ TryGetItemByte()

abstract bool TryGetItemByte	(	string	key,
		out byte	value
	)

pure virtual

Gets a value.

Parameters

key	Key
value	Value

Returns: True if the item was found in storage.

◆ TryGetItemByteArr()

abstract bool TryGetItemByteArr	(	string	key,
		out byte[]	value
	)

pure virtual

Gets a value.

Parameters

key	Key
value	Value

Returns: True if the item was found in storage.

◆ TryGetItemFloat()

abstract bool TryGetItemFloat	(	string	key,
		out float	value
	)

pure virtual

Gets a value.

Parameters

key	Key
value	Value

Returns: True if the item was found in storage.

◆ TryGetItemFloatArr()

abstract bool TryGetItemFloatArr	(	string	key,
		out float[]	value
	)

pure virtual

Gets a value.

Parameters

key	Key
value	Value

Returns: True if the item was found in storage.

◆ TryGetItemInt()

abstract bool TryGetItemInt	(	string	key,
		out int	value
	)

pure virtual

Gets a value.

Parameters

key	Key
value	Value

Returns: True if the item was found in storage.

◆ TryGetItemIntArr()

abstract bool TryGetItemIntArr	(	string	key,
		out int[]	value
	)

pure virtual

Gets a value.

Parameters

key	Key
value	Value

Returns: True if the item was found in storage.

◆ TryGetItemLong()

abstract bool TryGetItemLong	(	string	key,
		out long	value
	)

pure virtual

Gets a value.

Parameters

key	Key
value	Value

Returns: True if the item was found in storage.

◆ TryGetItemLongArr()

abstract bool TryGetItemLongArr	(	string	key,
		out long[]	value
	)

pure virtual

Gets a value.

Parameters

key	Key
value	Value

Returns: True if the item was found in storage.

◆ TryGetItemString()

abstract bool TryGetItemString	(	string	key,
		out string	value
	)

pure virtual

Gets a value.

Parameters

key	Key
value	Value

Returns: True if the item was found in storage.

◆ TryGetItemStringArr()

abstract bool TryGetItemStringArr	(	string	key,
		out string[]	value
	)

pure virtual

Gets a value.

Parameters

key	Key
value	Value

Returns: True if the item was found in storage.

◆ WriteToConsole()

abstract void WriteToConsole ( )

pure virtual

Writes the current storage data as to the output window in the map editor. For debugging only.