RAIN.Ontology.Decoration Class Reference

A Decoration is a mechanism for adding various descriptions to an Entity. More...

List of all members.

Public Member Functions
	Decoration ()
	Default constructor.
void	Initialize ()
	Initialize sets up a default Decoration.
void	Awake ()
	Handler for the Unity Awake() event to force initialization.
GameObject	GetRootDescribable ()
	GetRootDescribable gets the root game object in the hierarchy that has a Describable component.
GameObject	GetDescribable ()
	GetDescribable returns the Describable GameObject that is the closest parent to this decoration.
GameObject[]	GetDescribableAncestry ()
	GetDescribableAncestry returns a list of all GameObjects, including the GameObject to which the Decoration is attached that are Describable parents.
Public Attributes
Aspect	aspect
	Decorations have an Aspect associated with them that describes.

---

Detailed Description

A Decoration is a mechanism for adding various descriptions to an Entity.

---

Constructor & Destructor Documentation

RAIN.Ontology.Decoration.Decoration

(

)

Default constructor.

---

Member Function Documentation

void RAIN.Ontology.Decoration.Awake

(

)

Handler for the Unity Awake() event to force initialization.

GameObject RAIN.Ontology.Decoration.GetDescribable

(

)

GetDescribable returns the Describable GameObject that is the closest parent to this decoration.

Returns:

The closest parent Describable, or null if one is not found

GameObject [] RAIN.Ontology.Decoration.GetDescribableAncestry

(

)

GetDescribableAncestry returns a list of all GameObjects, including the GameObject to which the Decoration is attached that are Describable parents.

Returns:

An array of GameObjects, possibly of length 0

GameObject RAIN.Ontology.Decoration.GetRootDescribable

(

)

GetRootDescribable gets the root game object in the hierarchy that has a Describable component.

Returns:

The root Game Object, or null if one is not found

void RAIN.Ontology.Decoration.Initialize

(

)

Initialize sets up a default Decoration.

---

Member Data Documentation

Aspect RAIN.Ontology.Decoration.aspect

Decorations have an Aspect associated with them that describes.