Difference between revisions of "ShowRaceMenu - Game"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Plplecuyer
 
imported>Qazaaq
(added category)
 
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
'''Member of:''' [[Game Script]]
'''Member of:''' [[Game Script]]


Line 7: Line 5:
== Syntax ==
== Syntax ==
<source lang="papyrus">
<source lang="papyrus">
Function ShowRaceMenu(ObjectReference akMenuTarget = None, int uiMode = 0, ObjectReference akMenuSpouseFemale = None, \
Function ShowRaceMenu(ObjectReference akMenuTarget = none, int uiMode = 0, ObjectReference akMenuSpouseFemale = none, \
   ObjectReference akMenuSpouseMale = None, ObjectReference akVendor = None) native global
   ObjectReference akMenuSpouseMale = none, ObjectReference akVendor = none) Native Global
</source>
</source>


Line 30: Line 28:


== Return Value ==
== Return Value ==
None.
None


== Examples ==
== Examples ==
Line 40: Line 38:
== See Also ==
== See Also ==
*[[Game Script]]
*[[Game Script]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:User Interface]]

Latest revision as of 20:25, 11 February 2018

Member of: Game Script

Shows the race/sex change menu.

Syntax[edit | edit source]

Function ShowRaceMenu(ObjectReference akMenuTarget = none, int uiMode = 0, ObjectReference akMenuSpouseFemale = none, \
  ObjectReference akMenuSpouseMale = none, ObjectReference akVendor = none) Native Global

Parameters[edit | edit source]

  • akMenuTarget: The primary actor to be modified by the race menu
    • Default: None (use the Player)
  • uiMode : Determine the 'mode' of the menu to use
    • Default: 0
    • Valid values are:
      • 0: Start-of-game chargen
      • 1: Remake -- similar to start-of-game chargen except that only the player is editable and sex can't be changed
      • 2: Haircut
      • 3: Plastic Surgery
      • 4: Face Paint
  • akMenuSpouseFemale : The enabled female spouse used in the character generation version of the race menu.
    • Default: None
  • akMenuSpouseMale : The disabled male spouse used in the character generation version of the race menu.
    • Default: None
  • akVendor : The vendor providing any services (haircut, tattooing, etc.)
    • Default: None

Return Value[edit | edit source]

None

Examples[edit | edit source]

; Show the race/sex menu to let the player customize their character
Game.ShowRaceMenu()

See Also[edit | edit source]