Difference between revisions of "Osiris/API/ObjectSetFlag"
From Divinity Engine Wiki
m |
m |
||
| Line 2: | Line 2: | ||
* call '''ObjectSetFlag'''(''(GUIDSTRING)'''''_Target''', ''(STRING)'''''_Flag''', ''(INTEGER)'''''_DialogInstance''') | * call '''ObjectSetFlag'''(''(GUIDSTRING)'''''_Target''', ''(STRING)'''''_Flag''', ''(INTEGER)'''''_DialogInstance''') | ||
===== Description ===== | ===== Description ===== | ||
| − | Sets the (character/item) flag '''_Flag''' from '''_Target'''. The '''_DialogInstance''' parameter can be examined when catching the corresponding | + | Sets the (character/item) flag '''_Flag''' from '''_Target'''. The '''_DialogInstance''' parameter can be examined when catching the corresponding [[Osiris/API/ObjectFlagSet|ObjectFlagSet]] event, but is otherwise unused. |
===== Return Values ===== | ===== Return Values ===== | ||
* None | * None | ||
===== Notes ===== | ===== Notes ===== | ||
* There is an overload in the Shared mod without the last parameter, which passes 0. | * There is an overload in the Shared mod without the last parameter, which passes 0. | ||
| − | * When | + | * 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 set the flag for all shapeshift forms, including "not shapeshifted". |
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/ObjectClearFlag|ObjectClearFlag]] | * [[Osiris/API/ObjectClearFlag|ObjectClearFlag]] | ||
Revision as of 22:38, 29 October 2017
Full Definition(s)
- call ObjectSetFlag((GUIDSTRING)_Target, (STRING)_Flag, (INTEGER)_DialogInstance)
Description
Sets the (character/item) flag _Flag from _Target. The _DialogInstance parameter can be examined when catching the corresponding ObjectFlagSet event, but is otherwise unused.
Return Values
- None
Notes
- There is an overload in the Shared mod without the last parameter, which passes 0.
- 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 set the flag for all shapeshift forms, including "not shapeshifted".
