Script:unsetcontrolledzone: Difference between revisions

From Arx Libertatis Wiki
Jump to navigation Jump to search
(Created page with "{{Stub}} This page describes the <code>unsetcontrolledzone</code> script command. Usage: unsetcontrolledzone <zone> Parameters: {| class="wikitable sortable" ! Parameter...")
 
mNo edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Stub}}
{{ScriptCommandPage
 
|description=remove the controlling entity from a [[zone]]
This page describes the <code>unsetcontrolledzone</code> script command.
|parameters=
 
zone string Name of the zone to relinquish control of
Usage:
|intro=After executing this command the entity that previously took control of the zone using the {{Command|setcontrolledzone}} command will no longer receive {{Event|controlledzone_enter}} and {{Event|controlledzone_leave}} events when the player, [[:Category:Items|items]] or [[:Category:NPCs|NPCs]] enter or leave that zone.
 
}}
unsetcontrolledzone <zone>
 
Parameters:
{| class="wikitable sortable"
! Parameter
! Type
! Description
|-
| <code><zone></code>
| {{text}}
| Name of the zone for which to unset the controlling entity
|}
 
The controlling entity for a zone will receive script events when any entities enter or leave that zone.
 
[[Category:Script commands]]

Latest revision as of 01:48, 17 April 2020

The unsetcontrolledzone script command is used to remove the controlling entity from a zone. After executing this command the entity that previously took control of the zone using the setcontrolledzone command will no longer receive controlledzone_enter and controlledzone_leave events when the player, items or NPCs enter or leave that zone.

Usage

unsetcontrolledzone <zone>

Context: Ignored

Parameters:

ParameterTypeDescription
zone string Name of the zone to relinquish control of