cover

obj_uiZ_cover

An object made to cover things up when menus or popups are open. This object may at any point destroy itself when destroyonclick is set to true, please check whether it still exists when using it.

The cover is just a square being drawn consisting of a color and alpha. To set the alpha, use the built in alpha function of uiz: uiz_alpha(instanceid, head_alpha, image_alpha).

For an example on how to use this, take a look at obj_uiZ_template_0

Property Variables

• color[c_black]: The color the cover should have.
• enabled[true]: Whether the cover is enabled or not. If it isn't enabled then the mouse will be completely ignored (pass through the object) and nothing will be drawn.
• disablemouse[true]: Whether the object should allow mouse clicks to pass or not. True for not letting clicks pass(actually normal uiz object behavior) behind the cover, and false for letting mouse clicks pass.
• ignorecontain[false]: Whether to disable any containment by uiz. Enabling this allows this objects to be drawn outside the bounds of it's parent.
• destroyonclick[true]: Whether to destroy the object when you click it. (With an animation though)
• destroyalphaanimation[uiz_cubic_inout]: The animation to use when the object gets destroyed.
• destroyalphaanimationtime[uiz_cubic_inout]: The time in seconds the destroyalphaanimation takes.

Readable variables

• update: Whenever this object is being pressed. (kmouseover=2)
• updated: Whenever this object is in its destroy animation.

Functions

• uiz_cover_setcolor(instanceid, color):
  • instanceid: the instance id of the instance you want to modify
  • color[c_black]: The color the cover shou
• uiz_cover_settings(instanceid, disablemouse, ignorecontain,destroyonclick):
  • instanceid: the instance id of the instance you want to modify
  • disablemouse[true]: Whether the object should allow mouse clicks to pass or not. True for not letting clicks pass(actually normal uiz object behavior) behind the cover, and false for letting mouse clicks pass.
  • ignorecontain[false]: Whether to disable any containment by uiz. Enabling this allows this objects to be drawn outside the bounds of it's parent.
  • destroyonclick[true]: Whether to destroy the object when you click it. (With an animation though)
• uiz_cover_setanimation(instanceid, destroyalphaanimation, destroyalphaanimationtime):
  • instanceid: the instance id of the instance you want to modify
  • destroyalphaanimation[uiz_cubic_inout]: The animation to use when the object gets destroyed.
  • destroyalphaanimationtime[uiz_cubic_inout]: The time in seconds the destroyalphaanimation takes.