User Tools

Site Tools


areaprogs

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
areaprogs [2014/06/19 19:49]
astark
areaprogs [2014/06/19 19:56] (current)
vodur
Line 3: Line 3:
 Area progs are always lua scripts. Area progs are always lua scripts.
  
-|Argument|Type|Note| +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.
-|area|[[AREAProperties OR AREA]]|the area to whom the script is attached| +
-|ch1|[[CHProperties OR CH]]|see table| +
-|trigger|string|see table| +
-|trigtype|string|see table|+
  
 +^Argument ^Type ^Note |
 +^ch1 |[[:​chproperties_or_ch|CHProperties OR CH]] |see table |
 +^trigger |string |see table |
 +^trigtype |string |see table |
  
-|trigtype|area|ch1|trigger|Phrase type|Description| +^trigtype ​^ch1 ^trigger ​^Phrase type ^Description | 
-|enter|area|enterer|none|number(%chance)|Fires when player enters the area| +^enter |enterer |none |number(%chance) |Fires when player enters the area | 
-|*exit|area|exiter|none|number(%chance)|Fires when player exits the area| +^%%*%%exit |exiter |none |number(%chance) |Fires when player exits the area | 
-|renter|area|enterer|none|number(%chance)|Fires when player enters any room in the area| +^renter |enterer |none |number(%chance) |Fires when player enters any room in the area | 
-|*rexit|area|exiter|none|number(%chance)|Fires when player exits any room in the area| +^%%*%%rexit |exiter |none |number(%chance) |Fires when player exits any room in the area | 
-|*recall|area|recaller|none|number(%chance)|Fires when a player recalls from the area| +^%%*%%recall |recaller |none |number(%chance) |Fires when a player recalls from the area | 
-|boot|area|none|none|number(%chance)|Fires after mud boots or finishes copyover| +^boot |none |none |number(%chance) |Fires after mud boots or finishes copyover | 
-|shutdown|area|none|none|number(%chance)|Fires before mud shutdown/​copyover| +^shutdown |none |none |number(%chance) |Fires before mud shutdown/​copyover | 
-|quit|area|quitter|none|number(%chance)|Fires when player quits in the area| +^quit |quitter |none |number(%chance) |Fires when player quits in the area | 
-|void|area|voider|none|number(%chance)|Fires when player voids in the area| +^void |voider |none |number(%chance) |Fires when player voids in the area | 
-|unvoid|area|unvoider|none|number(%chance)|Fires immediately after player is returned to area| +^unvoid |unvoider |none |number(%chance) |Fires immediately after player is returned to area | 
-|[[timer]]|area|none|none|number(seconds interval)|Fires at an interval of x seconds (provided as phrase)|+^[[:timer|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.+(%%*%%)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 When recalling, order of trigger processing is: rexit then exit then recall
 +
 +\\
 +
areaprogs.txt · Last modified: 2014/06/19 19:56 by vodur