Difference between revisions of "AutoSclHudS"

Latest revision as of 17:48, 24 November 2008

A command for Pluggy.

Syntax:

For HudS (Surface/Image)

(AutoScale:bool) AutoSclHudS HudID:long AutoScale:bool Global:bool

For HudT (Text)

(AutoScale:bool) AutoSclHudT HudID:long AutoScale:bool Global:bool

Returns or sets the AutoScale of the Hud.

If AutoScale is not specified, it returns the AutoScale of the Hud.
If AutoScale is specified, it sets the AutoScale of the Hud.
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.
If the Hud does not exist, it returns -1.

@@ Line 2: / Line 2: @@
 '''Syntax:'''
+For HudS (Surface/Image)
   (AutoScale:bool) AutoSclHudS HudID:long ''AutoScale:bool'' ''Global:bool''
+For HudT (Text)
+ (AutoScale:bool) AutoSclHudT HudID:long ''AutoScale:bool'' ''Global:bool''
-Returns or sets the AutoScale of the HudS.
+Returns or sets the AutoScale of the Hud.
-*If AutoScale is not specified, it returns the AutoScale of the HudS.
+*If AutoScale is not specified, it returns the AutoScale of the Hud.
-*If AutoScale is specified, it sets the AutoScale of the HudS.
+*If AutoScale is specified, it sets the AutoScale of the Hud.
-**If you want to modify a HudS from another mod or "0" scripts (result scripts, console), 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.
+*If the Hud does not exist, it returns -1.
 [[Category: Functions (Pluggy)]]
 [[Category: Hud Functions (Pluggy)]]