Editing Game Script

Collection of game-specific global functions.

== Definition ==
<source lang="papyrus">
ScriptName Game Native Hidden
</source>

== Properties ==
None

== Structs ==
None

== F4SE Structs ==
*Struct [[PluginInfo Struct - Game|PluginInfo]]
**A structure that holds information about a plugin.

== Global Functions ==
*Function [[AddAchievement - Game|AddAchievement]](int aiAchievementID)
**Adds the specified achievement/trophy to the player's gamer profile.
*Function [[AddPerkPoints - Game|AddPerkPoints]](int aiPerkPoints)
**Adds the given number of perk points to the player. Clamped at 255.
*Function [[AdvanceSkill - Game|AdvanceSkill]](string asSkillName, float afMagnitude)
**Advance the given skill on the player by the provided amount of skill usage
*Function [[ClearPrison - Game|ClearPrison]]()
**Clears all Prison variables on the PlayerCharacter so the game will know he is out of prison.
*Function [[ClearTempEffects - Game|ClearTempEffects]]()
**Clears all temp effects (such as terrain effects) in the game.
*Function [[EnablePipboyHDRMask - Game|EnablePipboyHDRMask]](bool abEnable)
**Enables/disables the HDR mask for the pipboy screen.
*Function [[Error - Game|Error]](string asMessage)
**Emits an error and stack trace to the papyrus log and the game warning system (not removed by compiler in release builds)
*Function [[FadeOutGame - Game|FadeOutGame]](bool abFadingOut, bool abBlackFade, float afSecsBeforeFade, float afFadeDuration, bool abStayFaded)
**Fades the game in and out with the specified parameters.
*Function [[FastTravel - Game|FastTravel]](ObjectReference akDestination)
**Fast-travels the player to the specified object's location.
*Actor Function [[FindClosestActor - Game|FindClosestActor]](float afX, float afY, float afZ, float afRadius)
**Finds the closest actor within a given radius of a location
*Actor Function [[FindClosestActorFromRef - Game|FindClosestActorFromRef]](ObjectReference arCenter, float afRadius)
**Finds the closest actor within a given radius of a reference
*ObjectReference Function [[FindClosestReferenceOfAnyTypeInList - Game|FindClosestReferenceOfAnyTypeInList]](FormList arBaseObjects, float afX, float afY, float afZ, float afRadius)
**Finds the closest reference of any of the base objects in the list within a given radius of a location
*ObjectReference Function [[FindClosestReferenceOfAnyTypeInListFromRef - Game|FindClosestReferenceOfAnyTypeInListFromRef]](FormList arBaseObjects, ObjectReference arCenter, float afRadius)
**Finds the closest reference of any of the base objects in the list within a given radius of a reference
*ObjectReference Function [[FindClosestReferenceOfType - Game|FindClosestReferenceOfType]](Form arBaseObject, float afX, float afY, float afZ, float afRadius)
**Finds the closest reference of a given base object within a given radius of a location
*ObjectReference Function [[FindClosestReferenceOfTypeFromRef - Game|FindClosestReferenceOfTypeFromRef]](Form arBaseObject, ObjectReference arCenter, float afRadius)
**Finds the closest reference of a given base object within a given radius of a reference
*Actor Function [[FindRandomActor - Game|FindRandomActor]](float afX, float afY, float afZ, float afRadius)
**Finds a random actor within a given radius of a location
*Actor Function [[FindRandomActorFromRef - Game|FindRandomActorFromRef]](ObjectReference arCenter, float afRadius)
**Finds a random actor within a given radius of a reference
*ObjectReference Function [[FindRandomReferenceOfAnyTypeInList - Game|FindRandomReferenceOfAnyTypeInList]](FormList arBaseObjects, float afX, float afY, float afZ, float afRadius)
**Finds a random reference of any of the base objects in the list within a given radius of a location
*ObjectReference Function [[FindRandomReferenceOfAnyTypeInListFromRef - Game|FindRandomReferenceOfAnyTypeInListFromRef]](FormList arBaseObjects, ObjectReference arCenter, float afRadius)
**Finds a random reference of any of the base objects in the list within a given radius of a reference
*ObjectReference Function [[FindRandomReferenceOfType - Game|FindRandomReferenceOfType]](Form arBaseObject, float afX, float afY, float afZ, float afRadius)
**Finds a random reference of a given base object within a given radius of a location
*ObjectReference Function [[FindRandomReferenceOfTypeFromRef - Game|FindRandomReferenceOfTypeFromRef]](Form arBaseObject, ObjectReference arCenter, float afRadius)
**Finds a random reference of a given base object within a given radius of a reference
*Function [[ForceDisableSSRGodraysDirLight - Game|ForceDisableSSRGodraysDirLight]](bool abDisableSSR, bool abDisableGodrays, bool abDisableDirLight)
**Selectively disable certain rendering effects.
*Function [[ForceFirstPerson - Game|ForceFirstPerson]]()
**Forces the player camera into 1st-person.
*Function [[ForceThirdPerson - Game|ForceThirdPerson]]()
**Forces the player camera into 3rd-person.
*ActorValue Function [[GetAggressionAV - Game|GetAggressionAV]]()
** Get the Aggression Actor Value
*ActorValue Function [[GetAgilityAV - Game|GetAgilityAV]]()
** Get the Agility Actor Value
*MiscObject Function [[GetCaps - Game|GetCaps]]()
**Get the base Caps001 object, the basic unit of money in the game.
* ActorValue Function [[GetCharismaAV - Game|GetCharismaAV]]()
**Get the Charisma Actor Value
*ActorValue Function [[GetConfidenceAV - Game|GetConfidenceAV]]()
**Get the Confidence Actor Value
*int Function [[GetDifficulty - Game|GetDifficulty]]()
**Returns the game's current difficulty setting.
*ActorValue Function [[GetEnduranceAV - Game|GetEnduranceAV]]()
**Get the Endurance Actor Value
*Form Function [[GetForm - Game|GetForm]](int aiFormID)
**Obtains a [[Form Script|Form]] from the game by its form ID number.
*Form Function [[GetFormFromFile - Game|GetFormFromFile]](int aiFormID, string asFilename)
**Obtains a [[Form Script|Form]] from the game by its form ID number and expected file.
*float Function [[GetGameSettingFloat - Game|GetGameSettingFloat]](string asGameSetting)
**Obtains the value of a float game setting.
*float Function [[GetGameSettingInt - Game|GetGameSettingInt]](string asGameSetting)
**Obtains the value of an int game setting.
*float Function [[GetGameSettingString - Game|GetGameSettingString]](string asGameSetting)
**Obtains the value of a string game setting.
*ActorValue Function [[GetHealthAV - Game|GetHealthAV]]()
**Get the Health Actor Value
*ActorValue Function [[GetIntelligenceAV - Game|GetIntelligenceAV]]()
**Get the Intelligence Actor Value
*ActorValue Function [[GetLuckAV - Game|GetLuckAV]]()
**Get the Luck Actor Value
*ActorValue Function [[GetPerceptionAV - Game|GetPerceptionAV]]()
**Get the Perception Actor Value
*Actor Function [[GetPlayer - Game|GetPlayer]]()
**Obtains the [[Actor Script|Actor]] that represents the player.
*Actor[] Function [[GetPlayerFollowers - Game|GetPlayerFollowers]]()
**Returns an array of the player's followers.
*ObjectReference Function [[GetPlayerGrabbedRef - Game|GetPlayerGrabbedRef]]()
**Obtains the [[ObjectReference Script|ObjectReference]] the player is currently grabbing.
*float Function [[GetPlayerRadioFrequency - Game|GetPlayerRadioFrequency]]()
**Returns the frequency the player's radio is currently set at.
*Actor Function [[GetPlayersLastRiddenHorse - Game|GetPlayersLastRiddenHorse]]()
**Gets the player's last ridden horse, if any.
*int Function [[GetPlayerLevel - Game|GetPlayerLevel]]()
**Returns the player's current level
*float Function [[GetRealHoursPassed - Game|GetRealHoursPassed]]()
**Returns the number of real-life hours that have passed playing the game.
*ActorValue Function [[GetSuspiciousAV - Game|GetSuspiciousAV]]()
**Get the Suspicious Actor Value
*ActorValue Function [[GetStrengthAV - Game|GetStrengthAV]]()
**Get the Strength Actor Value
*int Function [[GetXPForLevel - Game|GetXPForLevel]](int auiLevel)
**Obtains the total amount of XP necessary to obtain the passed-in level
*Function [[GivePlayerCaps - Game|GivePlayerCaps]](int nCaps)
**Gives the player X caps
*Function [[HideTitleSequenceMenu - Game|HideTitleSequenceMenu]]()
**Hides the title sequence menu.
*Function [[IncrementSkill - Game|IncrementSkill]](ActorValue akActorValue, int aiCount)
**Advances the provided Skill by the given number of points (for the player only).
*Function [[IncrementStat - Game|IncrementStat]](string asStatName, int aiModAmount)
**Modifies the specified MiscStat by the given amount
*Function [[InitializeMarkerDistances - Game|InitializeMarkerDistances]]()
**Called to tell the Compass displays to refresh after gamesettings are updated related to hardcore mode
*bool Function [[IsActivateControlsEnabled - Game|IsActivateControlsEnabled]]()
**Are the activation controls enabled?
*bool Function [[IsCamSwitchControlsEnabled - Game|IsCamSwitchControlsEnabled]]()
**Are the camera switch controls enabled?
*bool Function [[IsFastTravelControlsEnabled - Game|IsFastTravelControlsEnabled]]()
**Are fast travel controls enabled?
*bool Function [[IsFastTravelEnabled - Game|IsFastTravelEnabled]]()
**Is fast travel enabled?
*bool Function [[IsFavoritesControlsEnabled - Game|IsFavoritesControlsEnabled]]()
**Is the favorites controls enabled?
*bool Function [[IsFightingControlsEnabled - Game|IsFightingControlsEnabled]]()
**Are the fighting controls enabled?
*bool Function [[IsJournalControlsEnabled - Game|IsJournalControlsEnabled]]()
**Are the journal menu controls enabled?
*bool Function [[IsJumpingControlsEnabled - Game|IsJumpingControlsEnabled]]()
**Are the jumping controls enabled?
*bool Function [[IsLookingControlsEnabled - Game|IsLookingControlsEnabled]]()
**Are the looking controls enabled?
*bool Function [[IsMenuControlsEnabled - Game|IsMenuControlsEnabled]]()
**Are the menu controls enabled?
*bool Function [[IsMovementControlsEnabled - Game|IsMovementControlsEnabled]]()
**Are the movement controls enabled?
*bool Function [[IsPluginInstalled - Game|IsPluginInstalled]](string asName)
**Checks to see if the specified plugin is installed and activated
*bool Function [[IsPlayerInRadioRange - Game|IsPlayerInRadioRange]](float afFrequency)
**Returns whether the player is within the outer radius of a transmitter using the given frequency.
*bool Function [[IsPlayerListening - Game|IsPlayerListening]](float afFrequency)
**Returns whether the player actively listening to a transmitter that uses the given frequency. 
*bool Function [[IsPlayerRadioOn - Game|IsPlayerRadioOn]]()
**Is the player's radio currently turned on?
*bool Function [[IsSneakingControlsEnabled - Game|IsSneakingControlsEnabled]]()
**Are the sneaking controls enabled?
*bool Function [[IsVATSControlsEnabled - Game|IsVATSControlsEnabled]]()
**Are the VATS controls enabled?
*bool Function [[IsVATSPlaybackActive - Game|IsVATSPlaybackActive]]()
**Is VATS playback currently running?
*Function [[PassTime - Game|PassTime]](int aiHours)
**Pass the given number of hours as if the player waited.
*Function [[PlayBink - Game|PlayBink]](string asFileName, bool abInterruptible, bool abMuteAudio, bool abMuteMusic, bool abLetterbox, bool abIsNewGameBink)
**Plays a bink video
*Function [[PlayEventCamera - Game|PlayEventCamera]](CameraShot akCamera, ObjectReference akRef)
**Plays an event camera attached to the given reference
*Function [[PrecacheCharGen - Game|PrecacheCharGen]]()
**Precaches all the data used by character gen to avoid hitches with file I/O.
*Function [[PrecacheCharGenClear - Game|PrecacheCharGenClear]]()
**Clears all the previously cached data used by character gen.
*int Function [[QueryStat - Game|QueryStat]](string asStat)
**Queries the given stat and returns its value.
*Function [[QuitToMainMenu - Game|QuitToMainMenu]]()
**Forces the game back to the main menu.
*Function [[RemovePlayerCaps - Game|RemovePlayerCaps]](int nCaps)
**Removes X caps from the player.
*Function [[RequestAutoSave - Game|RequestAutoSave]]()
**Requests for an auto-save to be made.
*Function [[RequestModel - Game|RequestModel]](string asModelName)
**Requests the specified model.
*Function [[RequestSave - Game|RequestSave]]()
**Requests for a normal save to be made.
*Function [[RewardPlayerXP - Game|RewardPlayerXP]](int auiXPAmount, bool abDirect)
**Rewards the player with a certain amount of XP, optionally ignoring any XP gain modifiers.
*Function [[ServeTime - Game|ServeTime]]()
**Has the player serve their jail time.
*Function [[SetCameraTarget - Game|SetCameraTarget]](Actor arTarget)
**Sets the camera target actor
*Function [[SetCharGenHUDMode - Game|SetCharGenHUDMode]](int aiCGHUDMode)
**Sets or clears CharGen-specific HUD modes.
*Function [[SetInChargen - Game|SetInChargen]](bool abDisableSaving, bool abDisableWaiting, bool abShowControlsDisabledMessage)
**Enable/disable various functionality which we want in chargen.
*Function [[SetInsideMemoryHUDMode - Game|SetInsideMemoryHUDMode]](bool aInsideMemory)
**Sets or clears InsideMemory HUD Mode
*Function [[SetPlayerAIDriven - Game|SetPlayerAIDriven]](bool abAIDriven)
**Enables or disables the AI driven flag on the player.
*Function [[SetPlayerOnElevator - Game|SetPlayerOnElevator]]|(bool abOnElevator)
**Sets/clears the player as on an elevator
*Function [[SetPlayerRadioFrequency - Game|SetPlayerRadioFrequency]](float afFrequency)
**Sets the frequency the player's radio should be turned to
*Function [[SetPlayerReportCrime - Game|SetPlayerReportCrime]](bool abReportCrime)
**Set the state of the player as an actor who commits crimes
*Function [[SetSittingRotation - Game|SetSittingRotation]](float afValue)
**Set the player's sitting camera offset rotation.
*Function [[ShakeCamera - Game|ShakeCamera]](ObjectReference akSource, float afStrength, float afDuration)
**Shakes the camera from the specified location with the specified strength.
*Function [[ShakeController - Game|ShakeController]](float afLeftStrength, float afRightStrength, float afDuration)
**Shakes the controller for the specified amount of time.
*Function [[ShowAllMapMarkers - Game|ShowAllMapMarkers]]()
**Shows all map markers on the world map.
*Function [[ShowFatigueWarningOnHUD - Game|ShowFatigueWarningOnHUD]]()
**Causes the Fatigue Warning to show on the HUD
*Function [[ShowFirstPersonGeometry - Game|ShowFirstPersonGeometry]](bool abShow)
**Shows or hides the first-person geometry
*Function [[ShowPerkVaultBoyOnHUD - Game|ShowPerkVaultBoyOnHUD]](string aVaultBoySwf, Sound aSoundDescriptor = None)
**Plays the specified Perk VaultBoy Swf and sound on the HUD.
*Function [[ShowPipboyBootSequence - Game|ShowPipboyBootSequence]](string asAnimationName)
**Shows the specified pipboy boot sequence
*Function [[ShowPipboyPlugin - Game|ShowPipboyPlugin]]()
**Shows the pipboy plugin animation on the pipboy
*Function [[ShowRaceMenu - Game|ShowRaceMenu]](ObjectReference akMenuTarget, int uiMode, ObjectReference akMenuSpouseFemale, ObjectReference akMenuSpouseMale, ObjectReference akVendor)
**Shows the race/sex change menu.
*Function [[ShowSPECIALMenu - Game|ShowSPECIALMenu]]()
**Shows the SPECIAL change menu.
*Function [[ShowTitleSequenceMenu - Game|ShowTitleSequenceMenu]]()
**Shows the title sequence menu.
*Function [[ShowTrainingMenu - Game|ShowTrainingMenu]](Actor aActor)
**Shows the training menu provided by actor parameter.
*Function [[StartDialogueCameraOrCenterOnTarget - Game|StartDialogueCameraOrCenterOnTarget]](ObjectReference akCameraTarget)
**Start dialogue cameras or swing first person camera to the target
*Function [[StartTitleSequence - Game|StartTitleSequence]](string asSequenceName)
**Plays the specified sequence in the title menu.
*Function [[StopDialogueCamera - Game|StopDialogueCamera]](bool abConsiderResume, bool abSwitchingTo1stP)
**Stops all dialogue cameras
*Function [[TriggerScreenBlood - Game|TriggerScreenBlood]](int aiValue)
**Trigger on-screen blood splatter.
*Function [[TurnPlayerRadioOn - Game|TurnPlayerRadioOn]](bool abRadioOn)
**Turns the player's radio on and off.
*bool Function [[UsingGamepad - Game|UsingGamepad]]()
**Returns whether the player is using a gamepad or not.
*Function [[Warning - Game|Warning]](string asMessage)
**Emits a warning to the papyrus log and the game warning system.

== F4SE Global Functions ==
*Int Function [[GetCameraState - Game|GetCameraState]]()
**Returns the current player camera state.

*ObjectReference Function [[GetCurrentConsoleRef - Game|GetCurrentConsoleRef]]()
**Returns the current console reference.

*PluginInfo[] Function [[GetInstalledPlugins - Game|GetInstalledPlugins]]()
**Returns an array of currently installed esm and esp files.

*PluginInfo[] Function [[GetInstalledLightPlugins - Game|GetInstalledLightPlugins]]()
**Returns an array of currently installed esl files.

*string[] Function [[GetPluginDependencies - Game|GetPluginDependencies]](string asPluginName)
**Returns an array of plugin dependencies for the specified plugin.

*Function [[SetGameSettingBool - Game|SetGameSettingBool]](string asSetting, bool abValue)
**Set the value of a boolean GameSetting.

*Function [[SetGameSettingInt - Game|SetGameSettingInt]](string asSetting, int aiValue)
**Set the value of a int GameSetting.

*Function [[SetGameSettingFloat - Game|SetGameSettingFloat]](string asSetting, float afValue)
**Set the value of a float GameSetting.

*Function [[SetGameSettingString - Game|SetGameSettingString]](string asSetting, string asString)
**Set the value of a string GameSetting.

== Member Functions ==
None

== F4SE Member Functions ==
None

== Events ==
None

== See Also ==
*[[Data_File|Data Files]]


[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]