Regions Documentation

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?

Files

filename	Description
region.lua	core logic for the region system, as well as event handlers for the dynamic window
region_dynamic_window.lua	dynamic window for the user interface
region_save_to_xml.lua	so you can save your regions to templates and reuse/reload them for later use.

Object Variables

ObjVar	Type	Description
Active	bool	true means its working, false means its not.
Bounds_Area	UserData(Box2d)	contains the box2d information about the view size.
Bounds_Height	number	the height of the view in units.
Bounds_Width	number	the width of the view in units.
Bounds_X	number	the upper left bounds of the view.
Bounds_Z	number	the upper left bounds of the view.
HeartBeat_Speed	number	how often the view checks to see if a new entity has entered or exited.
MessageTypeInfo	table	a table containing the pressed states of the Message Type for the object:SendMessage(value,Type).
MobilesInRegion	table	a table containing a list of non player mobiles in the views range.
NoReset	bool	to keep this from being destroyed by standard wipes.
ObjectsInRegion	table	a table containing a list of non-mobile objects that are in the views range
OnEnter_AddModToMobile	table	a table list of scripts that fire on a non player mobile when it enters the view.
OnEnter_AddModToPlayer	table	a table list of scripts that fire on a player mobile when it enters the view.
OnExit_AddModToMobile	table	a table list of scripts that fire on a non player mobile when it exits the view.
OnExit_AddModToPlayer	table	a table list of scripts that fire on a player mobile when it exits the view.
OnEnter_Message	string	The message sent to the player when they enter the view.
OnExit_Message	string	The message sent to the player when they exit the view.
PlayersInRegion	table	a table containing a list of player objects that are currently in the views range.
SearchType	string	a string value to help with future search functions.