====== _gen_door_are.nss ======

===== Usage =====

This script is used as a [[OnAreaTransitionClick]] script of the door or as a [[OnUsed]] script of the placeable or secret door.

This should be used by all doors. If special handling is required use [[Hooks]] to modify the behavior of this script.

===== What it does =====

This function will do following things:

  - [[Hooks]]: Call the [[builders:placeablesvariables#OnAreaTransitionClick|OnAreaTransitionClick]] or [[builders:placeablesvariables#OnUsed|OnUsed]] hooks if defined.
  - Traps: Block entry if object is trapped
  - Locks: Block entry if object is locked, or open the lock if PC has suitable keys. [[builders:placeablesvariables#Closing and Locking|Variables]].
  - Opening: Open the object if it is closed. [[builders:placeablesvariables#Closing and Locking|Variables]]. Visual effects used [[builders:placeablesvariables#open_vfx*]] and [[builders::placeablesvariables#open_vfx_player*]].
  - Broken: Block entry if variable ''broken'' is set.
  - Transfer: Transfer player and his henchman and summoned creatures to the target destination. [[builders:placeablesvariables#Destination and transfer|Variables]]. Visual effects used [[builders:placeablesvariables#transfer_vfx]], [[builders:placeablesvariables#transfer_vfx_target]] and [[builders:placeablesvariables#transfer_vfx_player*]].


===== Related things =====

[[builders:placeablesvariables|Variables in the placeables]]\\
[[Hooks]]\\
[[_gen_door_clo]]\\
[[_gen_door_dam]]\\
[[_gen_door_fai]]\\
[[_gen_door_loc]]\\
[[_gen_door_ope]]\\
[[_gen_door_unl]]