Area progs are attached in aedit with addaprog command.
Area progs are always lua scripts.
The variable 'area' is always available in the script, but note that it is not a function argument, but a global variable in the script environment.
| Argument | Type | Note |
|---|---|---|
| ch1 | CHProperties OR CH | see table |
| trigger | string | see table |
| trigtype | string | see table |
| trigtype | ch1 | trigger | Phrase type | Description |
|---|---|---|---|---|
| enter | enterer | none | number(%chance) | Fires when player enters the area |
| *exit | exiter | none | number(%chance) | Fires when player exits the area |
| renter | enterer | none | number(%chance) | Fires when player enters any room in the area |
| *rexit | exiter | none | number(%chance) | Fires when player exits any room in the area |
| *recall | recaller | none | number(%chance) | Fires when a player recalls from the area |
| boot | none | none | number(%chance) | Fires after mud boots or finishes copyover |
| shutdown | none | none | number(%chance) | Fires before mud shutdown/copyover |
| 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 |
| timer | none | none | number(seconds interval) | Fires at an interval of x seconds (provided as phrase) |
(*)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