Difference between revisions of "HudS X"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Haama
m (Not autoscale)
imported>Haama
m (Correction)
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:


'''Syntax:'''
'''Syntax:'''
For HudS (Surface/Image)
  (X:float) HudS_X HudID:long ''X:float'' ''Relative:bool'' ''Global:bool''
  (X:float) HudS_X HudID:long ''X:float'' ''Relative:bool'' ''Global:bool''
For HudT (Text)
(X:float) HudT_X HudID:long ''X:float'' ''Relative:bool'' ''Global:bool''


Returns or sets the X-Position of the HudS.
Returns or sets the X-Position of the Hud.
*If X-Position is not specified, it returns the X-Position of the HudS.
*If X-Position is not specified, it returns the X-Position of the Hud.
*If X-Position is specified, it sets the X-Position of the HudS.
*If X-Position is specified, it sets the X-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 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 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).
**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 ''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 HudS 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 HudS is protected the function will fail.
**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.


[[Category: Functions (Pluggy)]]
[[Category: Functions (Pluggy)]]
[[Category: Hud Functions (Pluggy)]]
[[Category: Hud Functions (Pluggy)]]

Latest revision as of 17:54, 24 November 2008

A command for Pluggy.

Syntax:

For HudS (Surface/Image)

(X:float) HudS_X HudID:long X:float Relative:bool Global:bool

For HudT (Text)

(X:float) HudT_X HudID:long X:float Relative:bool Global:bool

Returns or sets the X-Position of the Hud.

  • If X-Position is not specified, it returns the X-Position of the Hud.
  • If X-Position is specified, it sets the X-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[edit | edit source]

  • 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.