Difference between revisions of "Regions Documentation"
| Line 1: | Line 1: | ||
back to [[Project Phoenix#Regions]]<BR> | back to [[Project Phoenix#Regions]]<BR> | ||
Now that I have the region system done and up to date to be called a 1.0 version. It will be packed with a sweet easy to use interface to all you to fire scripts on monsters, or players exiting or entering the area. You can also adjust the size of the region/view with a simple Adjust View option. It also comes with my file saving strategy.So you can create templates, load em reuse them, change them. So lets get on to the white papers shall we? | Now that I have the region system done and up to date to be called a 1.0 version. It will be packed with a sweet easy to use interface to all you to fire scripts on monsters, or players exiting or entering the area. You can also adjust the size of the region/view with a simple Adjust View option. It also comes with my file saving strategy.So you can create templates, load em reuse them, change them. So lets get on to the white papers shall we? | ||
| + | ==Object Variables== | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! ObjVar !! Type !! Description | ||
| + | |- | ||
| + | | Active|| bool|| Example | ||
| + | |- | ||
| + | | Bounds_Area || UserData(Box2d)|| Example | ||
| + | |- | ||
| + | | Bounds_Height || number || Example | ||
| + | |- | ||
| + | | Bounds_Width || number || Example | ||
| + | |- | ||
| + | | Bounds_X || number || Example | ||
| + | |- | ||
| + | | Bounds_Z || number || Example | ||
| + | |- | ||
| + | | HeartBeat_Speed || number || Example | ||
| + | |- | ||
| + | | MessageTypeInfo || table || Example | ||
| + | |- | ||
| + | | MobilesInRegion || table || Example | ||
| + | |- | ||
| + | | NoReset || bool || Example | ||
| + | |- | ||
| + | | ObjectsInRegion || table || Example | ||
| + | |- | ||
| + | | OnEnter_AddModToMobile|| table || Example | ||
| + | |- | ||
| + | | OnEnter_AddModToPlayer || table || Example | ||
| + | |- | ||
| + | | OnExit_AddModToMobile || table || Example | ||
| + | |- | ||
| + | | OnExit_AddModToPlayer || table || Example | ||
| + | |- | ||
| + | | OnEnter_Message || string|| Example | ||
| + | |- | ||
| + | | OnExit_Message || string|| Example | ||
| + | |- | ||
| + | | PlayersInRegion || table|| Example | ||
| + | |- | ||
| + | | SearchType || string|| Example | ||
| + | |} | ||
Revision as of 02:44, 2 July 2018
back to Project Phoenix#Regions
Now that I have the region system done and up to date to be called a 1.0 version. It will be packed with a sweet easy to use interface to all you to fire scripts on monsters, or players exiting or entering the area. You can also adjust the size of the region/view with a simple Adjust View option. It also comes with my file saving strategy.So you can create templates, load em reuse them, change them. So lets get on to the white papers shall we?
Object Variables
| ObjVar | Type | Description |
|---|---|---|
| Active | bool | Example |
| Bounds_Area | UserData(Box2d) | Example |
| Bounds_Height | number | Example |
| Bounds_Width | number | Example |
| Bounds_X | number | Example |
| Bounds_Z | number | Example |
| HeartBeat_Speed | number | Example |
| MessageTypeInfo | table | Example |
| MobilesInRegion | table | Example |
| NoReset | bool | Example |
| ObjectsInRegion | table | Example |
| OnEnter_AddModToMobile | table | Example |
| OnEnter_AddModToPlayer | table | Example |
| OnExit_AddModToMobile | table | Example |
| OnExit_AddModToPlayer | table | Example |
| OnEnter_Message | string | Example |
| OnExit_Message | string | Example |
| PlayersInRegion | table | Example |
| SearchType | string | Example |
