Difference between revisions of "MUDL:Every zone reset"
From WikiName
(Created page with " __TOC__ = Overview = This MUDL function gets called for each room in a zone when it is reset. = Command Syntax = <pre> addproc room mudl setproc room ## every_zone_reset...") |
(→Global Variables) |
||
| Line 20: | Line 20: | ||
! Name !! Type !! Description | ! Name !! Type !! Description | ||
|- | |- | ||
| − | | %r | + | | %r / %room |
| Room | | Room | ||
| − | | The room that the MUDL script is attached to. | + | | The room in the game where the script is being run. This value may be null if the script is attached to an area. |
| + | |- | ||
| + | | %area | ||
| + | | Area | ||
| + | | The area (zone) in the game where the script is being run. | ||
| + | |- | ||
| + | | %parent | ||
| + | | Room or Area | ||
| + | | The in-game element that the MUDL script is attached to. It will be identical to one of %room or %area. | ||
| + | |- | ||
| + | | %procedure_index | ||
| + | | Integer | ||
| + | | The index of the current MUDL procedure on the %parent variable. | ||
|} | |} | ||
| − | |||
= Return Values = | = Return Values = | ||
Revision as of 20:50, 16 May 2017
Contents
Overview
This MUDL function gets called for each room in a zone when it is reset.
Command Syntax
addproc room mudl setproc room ## every_zone_reset
Global Variables
The following global variables are available:
| Name | Type | Description |
|---|---|---|
| %r / %room | Room | The room in the game where the script is being run. This value may be null if the script is attached to an area. |
| %area | Area | The area (zone) in the game where the script is being run. |
| %parent | Room or Area | The in-game element that the MUDL script is attached to. It will be identical to one of %room or %area. |
| %procedure_index | Integer | The index of the current MUDL procedure on the %parent variable. |
Return Values
The return value from this function is ignored.
Triggered Scripts
Only room scripts are triggered by this event. They are triggered after the zone commands have been run for the room.
Example
addproc room mudl setproc romo 0 every_zone_reset msg_room(%r, 'ZONE RESET!') @ setproc room 0 PROC_ENABLED 1 compile
