Difference between revisions of "Osiris/API/ObjectClearFlag"
From Divinity Engine Wiki
m |
|||
| Line 9: | Line 9: | ||
* When a character flag is set or cleared in a dialog, it is only set on the current shapeshift form of the character. This means that if the player afterwards uses the Mask of the Shapeshifter to shapeshift to a different form (or removes the mask while they were wearing it during the dialog), this flag's state will revert to whatever state it had when the player last had that state. However, the Osiris APIs always work on all shapeshift forms simultaneously. This means that this API will clear the flag for all shapeshift forms, including "not shapeshifted". | * When a character flag is set or cleared in a dialog, it is only set on the current shapeshift form of the character. This means that if the player afterwards uses the Mask of the Shapeshifter to shapeshift to a different form (or removes the mask while they were wearing it during the dialog), this flag's state will revert to whatever state it had when the player last had that state. However, the Osiris APIs always work on all shapeshift forms simultaneously. This means that this API will clear the flag for all shapeshift forms, including "not shapeshifted". | ||
| − | ==== See Also ==== | + | ===== See Also ===== |
* [[Osiris/API/ObjectSetFlag|ObjectSetFlag]] | * [[Osiris/API/ObjectSetFlag|ObjectSetFlag]] | ||
[[Category:Osiris Calls]] | [[Category:Osiris Calls]] | ||
Revision as of 20:59, 25 August 2017
Full Definition(s)
- call ObjectClearFlag((GUIDSTRING)_Target, (STRING)_Flag, (INTEGER)_DialogInstance)
Description
Unsets the (character/item) flag _Flag from _Target. The _DialogInstance parameter is ignored (remnant from previous design).
Return Values
- None
Notes
- There is an overload in the Shared mod without the last, superfluous parameter. It's easiest to use this one.
- When a character flag is set or cleared in a dialog, it is only set on the current shapeshift form of the character. This means that if the player afterwards uses the Mask of the Shapeshifter to shapeshift to a different form (or removes the mask while they were wearing it during the dialog), this flag's state will revert to whatever state it had when the player last had that state. However, the Osiris APIs always work on all shapeshift forms simultaneously. This means that this API will clear the flag for all shapeshift forms, including "not shapeshifted".
