Difference between revisions of "Osiris/API/ItemCanSitOn"
From Divinity Engine Wiki
(Documented ItemCanSitOn) |
m |
||
| Line 7: | Line 7: | ||
* '''_Bool''': '''1''' if the item has at least one of the following [[:Category:Use_Actions|use actions]]: [[Use_Action:Sit|sit]], [[Use_Action:Lie|lie]], or [[Use_Action:Constrain|constrain]]; '''0''' in other cases. | * '''_Bool''': '''1''' if the item has at least one of the following [[:Category:Use_Actions|use actions]]: [[Use_Action:Sit|sit]], [[Use_Action:Lie|lie]], or [[Use_Action:Constrain|constrain]]; '''0''' in other cases. | ||
===== Notes ===== | ===== Notes ===== | ||
| − | * This query returns '''1''' even if someone else is already occupying the item and there is no room for another character to "sit" on it. | + | * This query returns '''1''' even if someone else is already occupying the item and there is no room for another character to "sit" on it, or if the item was marked as [[Osiris/API/ItemSetCanInteract|non-interactable]]. |
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterUseItem|CharacterUseItem]] | * [[Osiris/API/CharacterUseItem|CharacterUseItem]] | ||
| − | * [[Osiris/API/ItemSetCanInteract|ItemSetCanInteract ]] | + | * [[Osiris/API/ItemSetCanInteract|ItemSetCanInteract]] |
[[Category:Osiris Queries|ItemCanSitOn]] | [[Category:Osiris Queries|ItemCanSitOn]] | ||
Latest revision as of 11:15, 27 November 2018
Full Definition(s)
- query ItemCanSitOn([in](ITEMGUID)_Item, [out](INTEGER)_Bool)
Description
Returns whether _Item is can be sat/lied on, or a character can be constrained to it.
Return Values
- Success/Failure: Default return value.
- _Bool: 1 if the item has at least one of the following use actions: sit, lie, or constrain; 0 in other cases.
Notes
- This query returns 1 even if someone else is already occupying the item and there is no room for another character to "sit" on it, or if the item was marked as non-interactable.
