Bucket Class

Bucket Class

Hartismere School

[This is preliminary documentation and is subject to change.]

A dictionary object to store any value.

Inheritance Hierarchy

SystemObject
EJW.TextBasedAdventureBucket

Namespace: EJW.TextBasedAdventure
Assembly: EJW.TextBasedAdventure (in EJW.TextBasedAdventure.dll) Version: 2.0.5850.21153

Syntax

[SerializableAttribute]
public class Bucket : IEnumerable<Object>, 
	IEnumerable

<SerializableAttribute>
Public Class Bucket
	Implements IEnumerable(Of Object), IEnumerable

[SerializableAttribute]
public ref class Bucket : IEnumerable<Object^>, 
	IEnumerable

[<SerializableAttribute>]
type Bucket =  
    class
        interface IEnumerable<Object>
        interface IEnumerable
    end

The Bucket type exposes the following members.

Properties

	Name	Description
	Count	Gets the number of items stored in the Bucket.
	Item	Gets or Sets the Bucket item at the specified key.
	Keys	A list of all the Keys in this Bucket.
	Values	A list of all the Values in this Bucket.

Methods

	Name	Description
	Add	Adds the specified item to the Bucket.
	ContainsKey	Determines whether the Bucket contains the specified key.
	Get	Retrieves the specified item from the Bucket.
	Remove	Removes the value with the specified key from the Bucket.

Remarks

Use the Bucket to store additional data.

Data held in a Bucket is stored when the player saves their progress.

Examples

To store a value representing the player's health:

Game.Bucket["player_health"] = 100;
...
Game.Bucket["player_health"] -= 1;
...
if (Game.Bucket["player_health"] <= 0) {
...
}