====== AreaProgs ======

Area progs are attached in aedit with addaprog command.

Area progs are always lua scripts.

^Script Argument^Type^Note|
|ch1|[[:lua:ch:members|CH]]|see table|
|trigger|string|see table|
|trigtype|string|see table|

The actual area to which the script is attached can be referenced in the script through '**area**' global variable (type [[:lua:area:members|AREA]]).

^trigtype^ch1^trigger^Phrase type^Description|
|enter|enterer|none|number(%chance)|Fires when player enters the area. \\ See [[:triggers:enterandexit|enter and exit triggers]].|
|<nowiki>*</nowiki>exit|exiter|none|number(%chance)|Fires when player exits the area. \\ See [[:triggers:enterandexit|enter and exit triggers]].|
|renter|enterer|none|number(%chance)|Fires when player enters any room in the area. \\ See [[:triggers:enterandexit|enter and exit triggers]].|
|<nowiki>*</nowiki>rexit|exiter|none|number(%chance)|Fires when player exits any room in the area. \\ See [[:triggers:enterandexit|enter and exit triggers]].|
|<nowiki>*</nowiki>recall|recaller|none|number(%chance)|Fires when a player recalls from the area. \\ See [[:triggers:enterandexit|enter and exit triggers]].|
|boot|none|none|number(%chance)|Fires after mud boots or finishes copyover|
|shutdown|none|none|number(%chance)|Fires before mud shutdown/copyover|
|connect|connecter|none|number(%chance)|Fires when player connects in the area. Does not fire on reconnect.|
|quit|quitter|none|number(%chance)|Fires when player quits in the area|
|void|voider|none|number(%chance)|Fires when player voids in the area|
|unvoid|unvoider|none|number(%chance)|Fires immediately after player is returned to area from the void|
|death|dier|none|number(%chance)|Fires when player dies in the area. Fires before players location changes.|
|<nowiki>*</nowiki>prereset|none|none|number(%chance)|Fires directly before the area resets.|
|postreset|none|none|number(%chance)|Fires directly after the area resets.|
|[[:triggers:timer|timer]]|none|none|number(seconds interval)|Fires at an interval of x seconds (provided as phrase)|

|(<nowiki>*</nowiki>)If trigger fires, command is prevented from going through unless 'return true' in the script.|

When recalling, order of trigger processing is: rexit then exit then recall

\\