Difference between revisions of "SetCharGenHUDMode - Game"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Docclox
m (→‎Parameters: option 3 was missing.)
imported>Qazaaq
(added category)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
'''Member of:''' [[Game Script]]
'''Member of:''' [[Game Script]]


Line 6: Line 4:
== Syntax ==
== Syntax ==
<source lang="papyrus">
<source lang="papyrus">
Function SetCharGenHUDMode(int aiCGHUDMode) native global
Function SetCharGenHUDMode(int aiCGHUDMode) Native Global
</source>
</source>


Line 14: Line 12:
**1 -- From CharGen start to leaving the house.  Most of HUD invisible except for crosshairs.
**1 -- From CharGen start to leaving the house.  Most of HUD invisible except for crosshairs.
**2 -- From leaving the house to entering the cryo-pod.  Crosshairs and compass.
**2 -- From leaving the house to entering the cryo-pod.  Crosshairs and compass.
**3 -- Disables the entire HUD.
**3 -- End of main quest line. Disables the entire HUD.


== Return Value ==
== Return Value ==
Line 32: Line 30:
== See Also ==
== See Also ==
*[[Game Script]]
*[[Game Script]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:User Interface]]

Latest revision as of 20:11, 11 February 2018

Member of: Game Script

Sets or clears CharGen-specific HUD modes.

Syntax[edit | edit source]

Function SetCharGenHUDMode(int aiCGHUDMode) Native Global

Parameters[edit | edit source]

  • aiCGHUDMode: Which HUD mode to set. Valid values:
    • 0 -- Clears all CharGen HUD modes
    • 1 -- From CharGen start to leaving the house. Most of HUD invisible except for crosshairs.
    • 2 -- From leaving the house to entering the cryo-pod. Crosshairs and compass.
    • 3 -- End of main quest line. Disables the entire HUD.

Return Value[edit | edit source]

None

Examples[edit | edit source]

; We're starting CharGen
Game.SetCharGenHUDMode(1)


; CharGen over!  Back to standard HUD mode
Game.SetCharGenHUDMode(0)

See Also[edit | edit source]