ACSUtils Wiki

An ACS library for ZDoom-based ports

User Tools

Site Tools


hud_library_state

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
hud_library_state [2017/04/17 17:21]
korshun
hud_library_state [2017/04/18 16:02]
korshun
Line 1: Line 1:
 ====== HUD Library State ====== ====== HUD Library State ======
  
-HUD library state can be reset to default using [[functions:HudResetState]].+[[HUD Library]] has a lot of settings telling it how to draw messages. It stores them in current **state**.  
 + 
 +This state can be reset to default using [[functions:HudResetState]]. It can be saved and restored using [[functions:HudPushState]] and [[functions:HudPopState]] respectively.
  
 ===== 2D drawing ===== ===== 2D drawing =====
Line 17: Line 19:
 The width and height of the [[HUD coordinate system]]. The width and height of the [[HUD coordinate system]].
  
-<note important>This width and height is stored **in HUD Library**. [[zdoom>SetHudSize]] is **not** a replacement for [[function:HudSetVirtualSize]], because HUD Library needs to overwrite actual SetHudSize dimensions to implement scaling.</note>+<note important>This width and height is stored **in HUD Library**. [[zdoom>SetHudSize]] is **not** a replacement for [[functions:HudSetVirtualSize]], because HUD Library needs to overwrite actual SetHudSize dimensions to implement scaling.</note>
  
-**Default:** 640x480+<note important>Virtual screen size is specified using fixed-point numbers. The restriction on integers in [[zdoom>SetHudSize]] is completely arbitrary.</note>
  
-Manipulated by: +<note important>Virtual screen size affects 3D message sizeThe scale of 3D messages will match that of 2D ones at 128 units from the camera plane.</note>
-  * [[functions:HudSetVirtualSize]]. +
-  * [[functions:HudUseDefaultSize]]. +
-  * [[functions:HudUseRealSize]].+
  
 +**Default:** 640x480
 +
 +Manipulated by [[functions:HudSetVirtualSize]].
 +----
 ==== Exclude status bar ==== ==== Exclude status bar ====
-Whether to exclude status bar from [[HUD coordinate system]].+Whether to exclude status bar from [[HUD coordinate system]]. This is equivalent to the third argument to [[zdoom>SetHudSize]].
  
 **Default:** false **Default:** false
Line 56: Line 59:
   * [[functions:HudSetInvScale]]   * [[functions:HudSetInvScale]]
   * [[functions:HudSetInvScaleXY]]   * [[functions:HudSetInvScaleXY]]
 +
 +<note tip>1 / scale = distance</note>
  
 ---- ----
Line 105: Line 110:
 ---- ----
  
-==== HUD Layer ====+==== Show in 3D view ==== 
 +Whether to show the message in 3D game view. If false, applies [[zdoom>HudMessage#Type_flags|HUDMSG_NOTWITH3DVIEW]] flag to the message. 
 + 
 +**Default:** true 
 + 
 +Manipulated by: [[functions:HudSetShowIn3DView]]. 
 +---- 
 + 
 +==== Show on overlay automap ==== 
 +Whether to show the message when overlay automap is enabled. If false, applies [[zdoom>HudMessage#Type_flags|HUDMSG_NOTWITHOVERLAYMAP]] flag to the message. 
 + 
 +**Default:** true 
 + 
 +Manipulated by: [[functions:HudSetShowOnOverlayAutomap]]. 
 +---- 
 + 
 +==== Show on full automap ==== 
 +Whether to show the message in full automap mode. If false, applies [[zdoom>HudMessage#Type_flags|HUDMSG_NOTWITHFULLMAP]] flag to the message. 
 + 
 +**Default:** true 
 + 
 +Manipulated by: [[functions:HudSetShowOnFullAutomap]]. 
 +---- 
 + 
 + 
 + 
 +==== HUD layer ====
 Which [[zdoom>HudMessage#HUD_layers|HUD layer]] to draw the message at. Uses HUDMSG_LAYER_* constants from ZDoom. Which [[zdoom>HudMessage#HUD_layers|HUD layer]] to draw the message at. Uses HUDMSG_LAYER_* constants from ZDoom.
  
Line 151: Line 182:
  
 Manipulated by [[functions:HudSetWordWrap]]. Manipulated by [[functions:HudSetWordWrap]].
 +----
 +
 +==== Text origin ====
 +Which point of the text box to position.
 +
 +Horizontal origin can be one of:
 +  * HUD_TEXTORIGIN_LEFT
 +  * HUD_TEXTORIGIN_CENTER
 +  * HUD_TEXTORIGIN_RIGHT
 +
 +Vertical origin can be one of:
 +  * HUD_TEXTORIGIN_TOP
 +  * HUD_TEXTORIGIN_CENTER
 +  * HUD_TEXTORIGIN_BOTTOM
 +
 +**Default:** HUD_TEXTORIGIN_CENTER HUD_TEXTORIGIN_CENTER
 +
 +Manipulated by:
 +  * [[functions:HudSetTextOrigin]]
 +  * [[functions:HudSetTextOriginX]]
 +  * [[functions:HudSetTextOriginY]]
 +
 ---- ----
  
hud_library_state.txt · Last modified: 2017/04/18 16:21 by korshun