Difference between revisions of "Osiris/API/ItemIsOpened"

From Divinity Engine Wiki
Jump to: navigation, search
(Documented ItemIsOpened)
 
m
Line 4: Line 4:
 
Returns whether '''_Item''' is opened. This query works both for doors and for items with an [[Use_Action:Open/Close|open/close use action]].
 
Returns whether '''_Item''' is opened. This query works both for doors and for items with an [[Use_Action:Open/Close|open/close use action]].
 
===== Return Values =====
 
===== Return Values =====
* '''Success/Failure''': Default return value. The routine
+
* '''Success/Failure''': Default return value.
* '''_Opened''': '''0''' if '''_Item''' is not a container, '''1''' otherwise.
+
* '''_Opened''': '''1''' if '''_Item''' is open, '''0''' otherwise.
 
===== Notes =====
 
===== Notes =====
 
* For items that cannot open/close, the query can either fail or return '''0'''.
 
* For items that cannot open/close, the query can either fail or return '''0'''.

Revision as of 15:27, 24 March 2019

Full Definition(s)
  • query ItemIsOpened([in](ITEMGUID)_Item, [out](INTEGER)_Opened)
Description

Returns whether _Item is opened. This query works both for doors and for items with an open/close use action.

Return Values
  • Success/Failure: Default return value.
  • _Opened: 1 if _Item is open, 0 otherwise.
Notes
  • For items that cannot open/close, the query can either fail or return 0.
See Also