Difference between revisions of "Osiris/API/SetOnStage"

From Divinity Engine Wiki
Jump to: navigation, search
(SetOnStage documentation)
 
Line 5: Line 5:
  
 
By default, all objects are on stage. When an object is set off-stage,
 
By default, all objects are on stage. When an object is set off-stage,
* it becomes inactive: none of its behaviour scripts will run;
+
* it becomes inactive: none of its reactions or scriptframes in behaviour scripts will run;
* it becomes invisible and cannot be interacted with by anything or anyone.
+
* it will ''still'' receive events;
 +
* it becomes invisible and cannot be interacted with by anything or anyone using game mechanics (combat, surfaces, ...)
  
 
===== Notes =====
 
===== Notes =====

Revision as of 21:11, 21 September 2017

Full Definition(s)
  • call SetOnStage((GUIDSTRING)_Object, (INTEGER)_OnStage)
Description

Depending on whether _OnStage is 0 or 1, sets _Object either off-stage or on-stage. Object can be a character or an item.

By default, all objects are on stage. When an object is set off-stage,

  • it becomes inactive: none of its reactions or scriptframes in behaviour scripts will run;
  • it will still receive events;
  • it becomes invisible and cannot be interacted with by anything or anyone using game mechanics (combat, surfaces, ...)
Notes
  • /
See Also