Osiris/API/ItemIsOpened: Difference between revisions
Jump to navigation
Jump to search
(Documented ItemIsOpened) |
mNo edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| 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. | * '''Success/Failure''': Default return value. | ||
* '''_Opened''': ''' | * '''_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'''. | ||
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/DoorIsClosing|DoorIsClosing]] | |||
* [[Osiris/API/DoorIsOpening|DoorIsOpening]] | * [[Osiris/API/DoorIsOpening|DoorIsOpening]] | ||
* [[Osiris/API/ItemIsClosed|ItemIsClosed]] | * [[Osiris/API/ItemIsClosed|ItemIsClosed]] | ||
* [[Osiris/API/ | * [[Osiris/API/ItemIsContainer|ItemIsContainer]] | ||
[[Category:Osiris Queries|ItemIsOpened]] | [[Category:Osiris Queries|ItemIsOpened]] | ||
Latest revision as of 07:47, 25 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.