Difference between revisions of "Osiris/API/ObjectFlagSet"

From Divinity Engine Wiki
Jump to: navigation, search
m
m
 
(One intermediate revision by the same user not shown)
Line 8: Line 8:
 
* '''_DialogInstance''': If the flag was set using a dialog node, '''_DialogInstance''' contains the dialog's instance ID. If the flag was set from story, '''_DialogInstance''' will contain whatever was passed as last parameter to '''ObjectSetFlag'''. If the flag was set from behaviour script, '''DialogInstance''' will be zero.
 
* '''_DialogInstance''': If the flag was set using a dialog node, '''_DialogInstance''' contains the dialog's instance ID. If the flag was set from story, '''_DialogInstance''' will contain whatever was passed as last parameter to '''ObjectSetFlag'''. If the flag was set from behaviour script, '''DialogInstance''' will be zero.
 
===== Notes =====
 
===== Notes =====
* /
+
* If you set an object flag that was already set, no '''ObjectFlagSet''' event will be raised.
 +
* When a [[Osiris/API/PartySetFlag|party]] resp. [[Osiris/API/UserSetFlag|user]] flag is set, an '''ObjectFlagSet''' event gets raised for every character in the party resp. controlled by the user, under the conditions of the previous of the previous point.
 
===== See Also =====
 
===== See Also =====
 +
* [[Osiris/API/GlobalFlagSet|GlobalFlagSet]]
 
* [[Osiris/API/ObjectClearFlag|ObjectClearFlag]]
 
* [[Osiris/API/ObjectClearFlag|ObjectClearFlag]]
 
* [[Osiris/API/ObjectFlagCleared|ObjectFlagCleared]]
 
* [[Osiris/API/ObjectFlagCleared|ObjectFlagCleared]]

Latest revision as of 07:55, 17 July 2019

Full Definition(s)
  • event ObjectFlagSet((STRING)_FlagName, (GUIDSTRING)_Speaker, (INTEGER)_DialogInstance)
Description

Thrown when the flag _FlagName is set on object _Speaker in the context indicated by _DialogInstance.

Parameters
  • _FlagName: The flag that is set.
  • _Speaker: The object on which the (character) flag is set.
  • _DialogInstance: If the flag was set using a dialog node, _DialogInstance contains the dialog's instance ID. If the flag was set from story, _DialogInstance will contain whatever was passed as last parameter to ObjectSetFlag. If the flag was set from behaviour script, DialogInstance will be zero.
Notes
  • If you set an object flag that was already set, no ObjectFlagSet event will be raised.
  • When a party resp. user flag is set, an ObjectFlagSet event gets raised for every character in the party resp. controlled by the user, under the conditions of the previous of the previous point.
See Also