User Tools

Site Tools


areaprogs

This is an old revision of the document!


Area progs are attached in aedit with addaprog command.

Area progs are always lua scripts.

ArgumentTypeNote
areaAREAProperties OR AREAthe area to whom the script is attached
ch1CHProperties OR CHsee table
triggerstringsee table
trigtypestringsee table
trigtypeareach1triggerPhrase typeDescription
enterareaenterernonenumber(%chance)Fires when player enters the area
*exitareaexiternonenumber(%chance)Fires when player exits the area
renterareaenterernonenumber(%chance)Fires when player enters any room in the area
*rexitareaexiternonenumber(%chance)Fires when player exits any room in the area
*recallarearecallernonenumber(%chance)Fires when a player recalls from the area
bootareanonenonenumber(%chance)Fires after mud boots or finishes copyover
shutdownareanonenonenumber(%chance)Fires before mud shutdown/copyover
quitareaquitternonenumber(%chance)Fires when player quits in the area
voidareavoidernonenumber(%chance)Fires when player voids in the area
unvoidareaunvoidernonenumber(%chance)Fires immediately after player is returned to area
TimerTrigger OR timerareanonenonenumber(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

areaprogs.1403232529.txt.gz · Last modified: 2014/06/20 02:48 by astark