Latest revision as of 01:46, 17 April 2020

The setcontrolledzone script command is used to set the controlling entity of a zone for an entity. The entity executing this command will receive controlledzone_enter and controlledzone_leave events when the player, items or NPCs enter or leave that zone. Control of a zone can be relinquished using the unsetcontrolledzone command.

Usage

setcontrolledzone <zone>

Context: Any Entity

Parameters:

Parameter	Type	Description
`zone`	`string`	Name of the zone to take control of

@@ Line 1: / Line 1: @@
-{{Stub}}
+{{ScriptCommandPage
+|description=set the controlling entity of a [[zone]]
-This page describes the <code>setcontrolledzone</code> script command.
+|context=any
+|parameters=
-Usage:
+zone string Name of the zone to take control of
+|intro=The entity executing this command will receive {{Event|controlledzone_enter}} and {{Event|controlledzone_leave}} events when the player, [[:Category:Items|items]] or [[:Category:NPCs|NPCs]] enter or leave that zone. Control of a zone can be relinquished using the {{Command|unsetcontrolledzone}} command.
- setcontrolledzone <zone>
+}}
-Parameters:
-{| class="wikitable sortable"
-! Parameter
-! Type
-! Description
-|-
-| <code><zone></code>
-| {{text}}
-| Name of the zone for which to set the controller to the current entity
-|}
-The controlling entity for a zone will receive script events when any entities enter or leave that zone.
-[[Category:Script commands]]