Difference between revisions of "GameObj"
| Line 2: | Line 2: | ||
A potion, a monster, a door, and a sword are all examples of GameObjs. | A potion, a monster, a door, and a sword are all examples of GameObjs. | ||
| + | == Game Object Properties == | ||
| + | * Id | ||
| + | **The unique Id of a GameObject, Ids are unique on a per cluster basis. | ||
| + | **Getting the Id of a gameObject: <code>mId = obj.Id</code> | ||
| + | **Referencing a gameObj from a known Id: <code>mGameObj = GameObj(mId)</code | ||
| + | * Name | ||
| + | **Getter: <code>mName = mObj:GetName()</code> | ||
| + | **Setter: <code>mObj:SetName("Samogh the Balcksmith")</code> | ||
| + | |||
| + | Hue | ||
| + | |||
| + | |||
== Tips == | == Tips == | ||
* Obj variables should only contain data you are intending to persist to disk, especially since reading from an ObjVar immediately after setting it will not always return the new value. | * Obj variables should only contain data you are intending to persist to disk, especially since reading from an ObjVar immediately after setting it will not always return the new value. | ||
* GameObj can communicate between each other using [[SendMessage]] just like Modules. | * GameObj can communicate between each other using [[SendMessage]] just like Modules. | ||
| + | |||
| + | |||
[[Category:Architecture]] | [[Category:Architecture]] | ||
Revision as of 12:33, 1 November 2016
Game Object (GameObj) is a Dynamic object within the game that can occupy a position of the world, including a Container. Game Objects are the most common of all Objects and can have Variables and/or Modules attached to them.
A potion, a monster, a door, and a sword are all examples of GameObjs.
Game Object Properties
- Id
- The unique Id of a GameObject, Ids are unique on a per cluster basis.
- Getting the Id of a gameObject:
mId = obj.Id - Referencing a gameObj from a known Id:
mGameObj = GameObj(mId)</code
- Name
- Getter:
mName = mObj:GetName() - Setter:
mObj:SetName("Samogh the Balcksmith")
- Getter:
Hue
Tips
- Obj variables should only contain data you are intending to persist to disk, especially since reading from an ObjVar immediately after setting it will not always return the new value.
- GameObj can communicate between each other using SendMessage just like Modules.
