Difference between revisions of "SetGameSettingFloat - Game"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
(added notes and descriptions)
imported>Mr Stealyogir
(Added Description and example)
 
(One intermediate revision by one other user not shown)
Line 3: Line 3:
{{Template:Papyrus:RequiredF4SE|version=0.3.2}}
{{Template:Papyrus:RequiredF4SE|version=0.3.2}}


Sets the float value of a [[Game Setting]].  
This function sets a Game Setting to the specified value.
 
These include all the variables listed under Gameplay->Settings menu in the creation kit, but *does not* include variables set in the ini files. To set ini variables see [[SetINIFloat - Utility|SetINIFloat]].


== Syntax ==
== Syntax ==
Line 11: Line 13:


== Parameters ==
== Parameters ==
*asSetting: The setting name and section.
*asSetting: Placeholder Description.
*afValue: The new value to use.
*afValue: Placeholder Description.


== Return Value ==
== Return Value ==
Line 19: Line 21:
== Examples ==
== Examples ==
<source lang="papyrus">
<source lang="papyrus">
Utility.SetINIFloat("fDefault1stPersonFOV:Display", 100.0)
;Set Actor Teleport Fade Seconds
Game.SetGameSettingBool("fActorTeleportFadeSeconds", 1.5)
</source>
</source>
== Notes ==
*Changes to INI settings require including the section that the setting is in.


== See Also ==
== See Also ==

Latest revision as of 12:30, 23 December 2018

This article has been flagged as incomplete.
Please help improve the wiki by learning how to contribute.

F4SE Member of: Game Script
Requires F4SE version 0.3.2 or higher.

This function sets a Game Setting to the specified value.

These include all the variables listed under Gameplay->Settings menu in the creation kit, but *does not* include variables set in the ini files. To set ini variables see SetINIFloat.

Syntax[edit | edit source]

Function SetGameSettingFloat(string asSetting, float afValue) Native Global

Parameters[edit | edit source]

  • asSetting: Placeholder Description.
  • afValue: Placeholder Description.

Return Value[edit | edit source]

  • None

Examples[edit | edit source]

;Set Actor Teleport Fade Seconds
Game.SetGameSettingBool("fActorTeleportFadeSeconds", 1.5)

See Also[edit | edit source]