Difference between revisions of "HudSProtect"
Jump to navigation
Jump to search
imported>Haama (Created) |
imported>Haama (Combined HudT function) |
||
| Line 2: | Line 2: | ||
'''Syntax:''' | '''Syntax:''' | ||
For HudS (Surface/Image) | |||
(Protected:bool) HudSProtect HudID:long ''Protected:bool'' ''Global:bool'' | (Protected:bool) HudSProtect HudID:long ''Protected:bool'' ''Global:bool'' | ||
For HudT (Text) | |||
(Protected:bool) HudTProtect HudID:long ''Protected:bool'' ''Global:bool'' | |||
Returns or sets the protected status of the Hud. If protected is set to non-0, it will be write-protected from other mods, and only the associated mod will ever be able to modify the Hud. Setting Protected to 1 is recommended if you don’t want your Hud to be modified by another mod. | Returns or sets the protected status of the Hud. If protected is set to non-0, it will be write-protected from other mods, and only the associated mod will ever be able to modify the Hud. Setting Protected to 1 is recommended if you don’t want your Hud to be modified by another mod. | ||
*If Protected is not specified, it returns the current state. | *If Protected is not specified, it returns the current state. | ||
*If Protected is specified, it set the state and returns the new state. | *If Protected is specified, it set the state and returns the new state. | ||
*If the | *If the Hud does not exist, it returns -1. | ||
[[Category: Functions (Pluggy)]] | [[Category: Functions (Pluggy)]] | ||
[[Category: Hud Functions (Pluggy)]] | [[Category: Hud Functions (Pluggy)]] | ||
Revision as of 17:29, 24 November 2008
A command for Pluggy.
Syntax:
For HudS (Surface/Image)
(Protected:bool) HudSProtect HudID:long Protected:bool Global:bool
For HudT (Text)
(Protected:bool) HudTProtect HudID:long Protected:bool Global:bool
Returns or sets the protected status of the Hud. If protected is set to non-0, it will be write-protected from other mods, and only the associated mod will ever be able to modify the Hud. Setting Protected to 1 is recommended if you don’t want your Hud to be modified by another mod.
- If Protected is not specified, it returns the current state.
- If Protected is specified, it set the state and returns the new state.
- If the Hud does not exist, it returns -1.