HudS Y

A command for Pluggy.

Syntax:

For HudS (Surface/Image)

(Y:float) HudS_Y HudID:long Y:float Relative:bool Global:bool

For HudT (Text)

(Y:float) HudT_Y HudID:long Y:float Relative:bool Global:bool

Returns or sets the Y-Position of the Hud.

• If Y-Position is not specified, it returns the Y-Position of the Hud.
• If Y-Position is specified, it sets the Y-Position of the Hud.
  • The position is the center of the image (i.e., X=0 and Y=0 and center alignment will center the image exactly, with the center of the image in the center of the screen).
  • The scale is a pixel - for a 1600x1200 resolution there are 1600 units for the X-axis and 1200 for the Y-axis.
  • The location is relative to the alignment. For instance, for a 1600x1200 resolution a center alignment would have coordinates from -800 to 800 (X) and -600 to 600 (Y) and a top-left alignment would have coordinates from 0 to 1600 (X) and 0 to 1200 (Y).
    • If Relative is set to non-0, the location will be relative to the image's location instead of its alignment.
  • If you want to modify a Hud from another mod or "0" scripts (result scripts, console, batch scripts), you will need to set the Global flag to 1. If Global is 0 or unset the function will fail. If the Hud is protected the function will fail.

Notes

• Due to limitations of the Wiki software, the title of this article, and links to it, cannot display it correctly - there is an underscore (_) in the function's name.