C# Class PantheonPrototype.Item

An Item is an object that may be equipped and stored in an Inventory. The Item will have an action that may be called without knowledge of the actual function of the Item. This provides encapsulation and abstraction for the inventory.
Exibir arquivo Open project: Bacon41/PantheonPrototype

Public Properties

Property Type Description
HUDRepresentation Microsoft.Xna.Framework.Graphics.Texture2D
isNull bool
soundCueName string
type int

Protected Properties

Property Type Description
info String
itemTag String

Public Methods

Method Description
Item ( ) : System
Item ( Microsoft.Xna.Framework.Graphics.Texture2D HUDrep ) : System

One of those constructor thingies. Defined so that you can initialize all the thingies in the item class

Update ( GameTime gameTime, Pantheon gameReference ) : void

An update function to be called only on equipped items. Takes care of time sensitive functionality.

activate ( Pantheon gameReference, CharacterEntity holder ) : void

The super ambiguous function designed to be super ambiguous. Basically, call this function for some random object to do some random thing. See? Super ambiguous.

Method Details

Item() public method

public Item ( ) : System
return System

Item() public method

One of those constructor thingies. Defined so that you can initialize all the thingies in the item class
public Item ( Microsoft.Xna.Framework.Graphics.Texture2D HUDrep ) : System
HUDrep Microsoft.Xna.Framework.Graphics.Texture2D
return System

Update() public method

An update function to be called only on equipped items. Takes care of time sensitive functionality.
public Update ( GameTime gameTime, Pantheon gameReference ) : void
gameTime Microsoft.Xna.Framework.GameTime The elapsed game time for each update.
gameReference Pantheon A reference to the entire game.
return void

activate() public method

The super ambiguous function designed to be super ambiguous. Basically, call this function for some random object to do some random thing. See? Super ambiguous.
public activate ( Pantheon gameReference, CharacterEntity holder ) : void
gameReference Pantheon A supremely useful reference to everything, just in case you need it.
holder CharacterEntity A reference to the character holding the weapon.
return void

Property Details

HUDRepresentation public_oe property

The representation of the item on the HUD. For the moment, this is the same as the representation in the inventory. That could change.
public Texture2D,Microsoft.Xna.Framework.Graphics HUDRepresentation
return Microsoft.Xna.Framework.Graphics.Texture2D

info protected_oe property

protected String info
return String

isNull public_oe property

public bool isNull
return bool

itemTag protected_oe property

protected String itemTag
return String

soundCueName public_oe property

public string soundCueName
return string

type public_oe property

public int type
return int