Difference between revisions of "Game Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (→‎SKSE Global Functions: Added New SKSE Member Function)
imported>CraftySentinel
(Added SKSE Legendary Skill Functions)
Line 1: Line 1:
[[Category:Scripting]]
 
[[Category:Papyrus]]
'''Source:''' Creation Kit
[[Category:Script Objects]]
 
[[Category:SKSE]]
'''Extends:''' None
[[Category:SKSE Script Objects]]
 
'''Flags:''' [[Flag Reference|Hidden]]
 


Collection of game-specific global functions
Collection of game-specific global functions
Line 9: Line 11:
== Definition ==
== Definition ==
<source lang="papyrus">
<source lang="papyrus">
ScriptName Game
ScriptName Game Hidden
</source>
</source>


== Properties ==
None


== Global Functions ==
== 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)'''
{|class="wikitable" width =100%
*Adds the given number of perk points to the player. Clamped at 255.
!style="text-align:left;" width=25%|Function
!style="text-align:left;"|Description
|-
|[[AddAchievement - Game|'''AddAchievement'''(Int ''aiAchievementID'')]]
|Adds the specified achievement/trophy to the player's gamer profile.
|-
 
|[[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)'''
|[[AdvanceSkill - Game|'''AdvanceSkill'''(String ''asSkillName'', Float ''afMagnitude'')]]
*Advance the given skill on the player by the provided amount of skill usage
|Advance the given skill on the player by the provided amount of skill usage
|-


'''bool Function [[AddHavokBallAndSocketConstraint - Game|AddHavokBallAndSocketConstraint]](ObjectReference arRefA, string arRefANode, ObjectReference arRefB, string arRefBNode, float afRefALocalOffsetX, float afRefALocalOffsetY, float afRefALocalOffsetZ, float afRefBLocalOffsetX, float afRefBLocalOffsetY, float afRefBLocalOffsetZ)'''
|[[AddHavokBallAndSocketConstraint - Game|Bool '''AddHavokBallAndSocketConstraint'''(ObjectReference ''arRefA'', String ''arRefANode'', ObjectReference ''arRefB'', String ''arRefBNode'', Float ''afRefALocalOffsetX'', Float ''afRefALocalOffsetY'', Float ''afRefALocalOffsetZ'', Float ''afRefBLocalOffsetX'', Float ''afRefBLocalOffsetY'', Float ''afRefBLocalOffsetZ'')]]
*Adds a ball-and-socket constraint between two rigid bodies, identified by their ref and node names
|Adds a ball-and-socket constraint between two rigid bodies, identified by their ref and node names
|-


'''int Function [[CalculateFavorCost - Game|CalculateFavorCost]](int aiFavorPrice)'''
|[[CalculateFavorCost - Game|Int '''CalculateFavorCost'''(Int ''aiFavorPrice'')]]
*Calculates how many points the player would have to pay for a favor of the specified price.
|Calculates how many points the player would have to pay for a favor of the specified price.
|-


'''Function [[ClearPrison - Game|ClearPrison]]()'''
|[[ClearPrison - Game|'''ClearPrison'''()]]
*Clears all Prison variables on the PlayerCharacter so the game will know he is out of prison.
|Clears all Prison variables on the PlayerCharacter so the game will know he is out of prison.
|-


'''Function [[ClearTempEffects - Game|ClearTempEffects]]()'''
|[[ClearTempEffects - Game|'''ClearTempEffects'''()]]
*Clears all temp effects (such as terrain effects) in the game.
|Clears all temp effects (such as terrain effects) in the game.
|-


'''Function [[DisablePlayerControls - Game|DisablePlayerControls]](bool abMovement, bool abFighting, bool abCamSwitch, bool abLooking, bool abSneaking, bool abMenu, bool abActivate, bool abJournalTabs, int aiDisablePOVType)'''
|[[DisablePlayerControls - Game|'''DisablePlayerControls'''(Bool ''abMovement'', Bool ''abFighting'', Bool ''abCamSwitch'', Bool ''abLooking'', Bool ''abSneaking'', Bool ''abMenu'', Bool ''abActivate'', Bool ''abJournalTabs'', Int ''aiDisablePOVType'')]]
*Disables the specified player controls.
|Disables the specified player controls.
|-


'''Function [[EnableFastTravel - Game|EnableFastTravel]](bool abEnable)'''
|[[EnableFastTravel - Game|'''EnableFastTravel'''(Bool ''abEnable'')]]
*Enables or disables the player's ability to fast travel.
|Enables or disables the player's ability to fast travel.
|-


'''Function [[EnablePlayerControls - Game|EnablePlayerControls]](bool abMovement, bool abFighting, bool abCamSwitch, bool abLooking, bool abSneaking, bool abMenu, bool abActivate, bool abJournalTabs, int aiDisablePOVType)'''
|[[EnablePlayerControls - Game|'''EnablePlayerControls'''(Bool ''abMovement'', Bool ''abFighting'', Bool ''abCamSwitch'', Bool ''abLooking'', Bool ''abSneaking'', Bool ''abMenu'', Bool ''abActivate'', Bool ''abJournalTabs'', Int ''aiDisablePOVType'')]]
*Enables the specified player controls.
|Enables the specified player controls.
|-


'''Function [[FadeOutGame - Game|FadeOutGame]](bool abFadingOut, bool abBlackFade, float afSecsBeforeFade, float afFadeDuration)'''
|[[FadeOutGame - Game|'''FadeOutGame'''(Bool ''abFadingOut'', Bool ''abBlackFade'', Float ''afSecsBeforeFade'', Float ''afFadeDuration'')]]
*Fades the game in and out with the specified parameters.
|Fades the game in and out with the specified parameters.
|-


'''Function [[FastTravel - Game|FastTravel]](ObjectReference akDestination)'''
|[[FastTravel - Game|'''FastTravel'''(ObjectReference ''akDestination'')]]
*Fast-travels the player to the specified object's location.
|Fast-travels the player to the specified object's location.
|-


'''Actor Function [[FindClosestActor - Game|FindClosestActor]](float afX, float afY, float afZ, float afRadius)'''
|[[FindClosestActor - Game|Actor '''FindClosestActor'''(Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
*Finds the closest actor within a given radius of a location
|Finds the closest actor within a given radius of a location
|-


'''Actor Function [[FindClosestActorFromRef - Game|FindClosestActorFromRef]](ObjectReference arCenter, float afRadius)'''
|[[FindClosestActorFromRef - Game|Actor '''FindClosestActorFromRef'''(ObjectReference ''arCenter'', Float ''afRadius'')]]
*Finds the closest actor within a given radius of a reference
|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)'''
|[[FindClosestReferenceOfAnyTypeInList - Game|ObjectReference '''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
|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)'''
|[[FindClosestReferenceOfAnyTypeInListFromRef - Game|ObjectReference '''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
|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)'''
|[[FindClosestReferenceOfType - Game|ObjectReference '''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
|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)'''
|[[FindClosestReferenceOfTypeFromRef - Game|ObjectReference '''FindClosestReferenceOfTypeFromRef'''(Form ''arBaseObject'', ObjectReference ''arCenter'', Float ''afRadius'')]]
*Finds the closest reference of a given base object within a given radius of a reference
|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)'''
|[[FindRandomActor - Game|Actor '''FindRandomActor'''(Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
*Finds a random actor within a given radius of a location
|Finds a random actor within a given radius of a location
|-


'''Actor Function [[FindRandomActorFromRef - Game|FindRandomActorFromRef]](ObjectReference arCenter, float afRadius)'''
|[[FindRandomActorFromRef - Game|Actor '''FindRandomActorFromRef'''(ObjectReference ''arCenter'', Float ''afRadius'')]]
*Finds a random actor within a given radius of a reference
|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)'''
|[[FindRandomReferenceOfAnyTypeInList - Game|ObjectReference '''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
|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)'''
|[[FindRandomReferenceOfAnyTypeInListFromRef - Game|ObjectReference '''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
|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)'''
|[[FindRandomReferenceOfType - Game|ObjectReference '''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
|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)'''
|[[FindRandomReferenceOfTypeFromRef - Game|ObjectReference '''FindRandomReferenceOfTypeFromRef'''(Form ''arBaseObject'', ObjectReference ''arCenter'', Float ''afRadius'')]]
*Finds a random reference of a given base object within a given radius of a reference
|Finds a random reference of a given base object within a given radius of a reference
|-


'''Function [[ForceFirstPerson - Game|ForceFirstPerson]]()'''
|[[ForceFirstPerson - Game|'''ForceFirstPerson'''()]]
*Forces the player camera into 1st-person.
|Forces the player camera into 1st-person.
|-


'''Function [[ForceThirdPerson - Game|ForceThirdPerson]]()'''
|[[ForceThirdPerson - Game|'''ForceThirdPerson'''()]]
*Forces the player camera into 3rd-person.
|Forces the player camera into 3rd-person.
|-


'''Form Function [[GetForm - Game|GetForm]](int aiFormID)'''
|[[GetForm - Game|Form '''GetForm'''(Int ''aiFormID'')]]
*Obtains a [[Form Script|Form]] from the game by its form ID number.
|Obtains a [[Form Script|Form]] from the game by its form ID number.
|-


'''Form Function [[GetFormFromFile - Game|GetFormFromFile]](int aiFormID, string asFilename)'''
|[[GetFormFromFile - Game|Form '''GetFormFromFile'''(Int ''aiFormID'', String ''asFilename'')]]
*Obtains the form specified by its form ID number which originated in the specified file.
|Obtains the form specified by its form ID number which originated in the specified file.
|-


'''float Function [[GetGameSettingFloat - Game|GetGameSettingFloat]](string asGameSetting)'''
|[[GetGameSettingFloat - Game|Float '''GetGameSettingFloat'''(String ''asGameSetting'')]]
*Obtains the value of a float game setting.
|Obtains the value of a float game setting.
|-


'''float Function [[GetGameSettingInt - Game|GetGameSettingInt]](string asGameSetting)'''
|[[GetGameSettingInt - Game|Float '''GetGameSettingInt'''(String ''asGameSetting'')]]
*Obtains the value of an int game setting.
|Obtains the value of an int game setting.
|-


'''float Function [[GetGameSettingString - Game|GetGameSettingString]](string asGameSetting)'''
|[[GetGameSettingString - Game|Float '''GetGameSettingString'''(String ''asGameSetting'')]]
*Obtains the value of a string game setting.
|Obtains the value of a string game setting.
|-


'''Actor Function [[GetPlayer - Game|GetPlayer]]()'''
|[[GetPlayer - Game|Actor '''GetPlayer'''()]]
*Obtains the [[Actor Script|Actor]] that represents the player.
|Obtains the [[Actor Script|Actor]] that represents the player.
|-


'''ObjectReference Function [[GetPlayerGrabbedRef - Game|GetPlayerGrabbedRef]]()'''
|[[GetPlayerGrabbedRef - Game|ObjectReference '''GetPlayerGrabbedRef'''()]]
*Obtains the [[ObjectReference Script|ObjectReference]] the player is currently grabbing.
|Obtains the [[ObjectReference Script|ObjectReference]] the player is currently grabbing.
|-


'''Actor Function [[GetPlayersLastRiddenHorse - Game|GetPlayersLastRiddenHorse]]()'''
|[[GetPlayersLastRiddenHorse - Game|Actor '''GetPlayersLastRiddenHorse'''()]]
*Gets this actors last ridden horse if it is the player. Returns None if player has not ridden a horse is not the player.
|Gets this actors last ridden horse if it is the player. Returns None if player has not ridden a horse is not the player.
|-


'''float Function [[GetRealHoursPassed - Game|GetRealHoursPassed]]()'''
|[[GetRealHoursPassed - Game|Float '''GetRealHoursPassed'''()]]
*Returns the number of real-life hours that have passed playing the game.
|Returns the number of real-life hours that have passed playing the game.
|-


'''float Function [[GetSunPositionX - Game|GetSunPositionX]]()'''
|[[GetSunPositionX - Game|Float '''GetSunPositionX'''()]]
*Gets the X position of the sun.
|Gets the X position of the sun.
|-


'''float Function [[GetSunPositionY - Game|GetSunPositionY]]()'''
|[[GetSunPositionY - Game|Float '''GetSunPositionY'''()]]
*Gets the Y position of the sun.
|Gets the Y position of the sun.
|-


'''float Function [[GetSunPositionZ - Game|GetSunPositionZ]]()'''
|[[GetSunPositionZ - Game|Float '''GetSunPositionZ'''()]]
*Gets the Z position of the sun.
|Gets the Z position of the sun.
|-


'''Function [[HideTitleSequenceMenu - Game|HideTitleSequenceMenu]]()'''
|[[HideTitleSequenceMenu - Game|'''HideTitleSequenceMenu'''()]]
*Hides the title sequence menu.
|Hides the title sequence menu.
|-


'''Function [[IncrementSkill - Game|IncrementSkill]](string asSkillName)'''
|[[IncrementSkill - Game|'''IncrementSkill'''(String ''asSkillName'')]]
*Advances the provided Skill by the one point (for the player only).
|Advances the provided Skill by the one point (for the player only).
|-


'''Function [[IncrementSkillBy - Game|IncrementSkillBy]](string asSkillName, int aiCount)'''
|[[IncrementSkillBy - Game|'''IncrementSkillBy'''(String ''asSkillName'', Int ''aiCount'')]]
*Advances the provided Skill by the given number of points (for the player only).
|Advances the provided Skill by the given number of points (for the player only).
|-


'''Function [[IncrementStat - Game|IncrementStat]](string asStatName, int aiModAmount) native global'''
|[[IncrementStat - Game|'''IncrementStat'''(String ''asStatName'', Int ''aiModAmount'')]]
*Modifies the specified MiscStat by the given amount
|Modifies the specified MiscStat by the given amount
|-


'''bool Function [[IsActivateControlsEnabled - Game|IsActivateControlsEnabled]]()'''
|[[IsActivateControlsEnabled - Game|Bool '''IsActivateControlsEnabled'''()]]
*Are the activation controls enabled?
|Are the activation controls enabled?
|-


'''bool Function [[IsCamSwitchControlsEnabled - Game|IsCamSwitchControlsEnabled]]()'''
|[[IsCamSwitchControlsEnabled - Game|Bool '''IsCamSwitchControlsEnabled'''()]]
*Are the camera switch controls enabled?
|Are the camera switch controls enabled?
|-


'''bool Function [[IsFastTravelEnabled - Game|IsFastTravelEnabled]]()'''
|[[IsFastTravelEnabled - Game|Bool '''IsFastTravelEnabled'''()]]
*Is fast travel enabled?
|Is fast travel enabled?
|-


'''bool Function [[IsFastTravelControlsEnabled - Game|IsFastTravelControlsEnabled]]()'''
|[[IsFastTravelControlsEnabled - Game|Bool '''IsFastTravelControlsEnabled'''()]]
*Are fast travel controls enabled?
|Are fast travel controls enabled?
|-


'''bool Function [[IsFightingControlsEnabled - Game|IsFightingControlsEnabled]]()'''
|[[IsFightingControlsEnabled - Game|Bool '''IsFightingControlsEnabled'''()]]
*Are the fighting controls enabled?
|Are the fighting controls enabled?
|-


'''bool Function [[IsJournalControlsEnabled - Game|IsJournalControlsEnabled]]()'''
|[[IsJournalControlsEnabled - Game|Bool '''IsJournalControlsEnabled'''()]]
*Are the journal menu controls enabled?
|Are the journal menu controls enabled?
|-


'''bool Function [[IsLookingControlsEnabled - Game|IsLookingControlsEnabled]]()'''
|[[IsLookingControlsEnabled - Game|Bool '''IsLookingControlsEnabled'''()]]
*Are the looking controls enabled?
|Are the looking controls enabled?
|-


'''bool Function [[IsMenuControlsEnabled - Game|IsMenuControlsEnabled]]()'''
|[[IsMenuControlsEnabled - Game|Bool '''IsMenuControlsEnabled'''()]]
*Are the menu controls enabled?
|Are the menu controls enabled?
|-


'''bool Function [[IsMovementControlsEnabled - Game|IsMovementControlsEnabled]]()'''
|[[IsMovementControlsEnabled - Game|Bool '''IsMovementControlsEnabled'''()]]
*Are the movement controls enabled?
|Are the movement controls enabled?
|-


'''bool Function [[IsPlayerSungazing - Game|IsPlayerSungazing]]()'''
|[[IsPlayerSungazing - Game|Bool '''IsPlayerSungazing'''()]]
*Checks to the see if the player is looking directly at the sun.
|Checks to the see if the player is looking directly at the sun.
|-


'''bool Function [[IsSneakingControlsEnabled - Game|IsSneakingControlsEnabled]]()'''
|[[IsSneakingControlsEnabled - Game|Bool '''IsSneakingControlsEnabled'''()]]
*Are the sneaking controls enabled?
|Are the sneaking controls enabled?
|-


'''bool Function [[IsWordUnlocked - Game|IsWordUnlocked]](WordOfPower akWord)'''
|[[IsWordUnlocked - Game|Bool '''IsWordUnlocked'''(WordOfPower ''akWord'')]]
*Is the word of power unlocked on the player?
|Is the word of power unlocked on the player?
|-


'''Function [[PlayBink - Game|PlayBink]](string asFileName, bool abInterruptible, bool abMuteAudio, bool abMuteMusic, bool abLetterbox)'''
|[[PlayBink - Game|'''PlayBink'''(String ''asFileName'', Bool ''abInterruptible'', Bool ''abMuteAudio'', Bool ''abMuteMusic'', Bool ''abLetterbox'')]]
*Plays a bink video
|Plays a bink video
|-


'''Function [[PrecacheCharGen - Game|PrecacheCharGen]]()'''
|[[PrecacheCharGen - Game|'''PrecacheCharGen'''()]]
*Precaches all the data used by character gen to avoid hitches with file I/O.
|Precaches all the data used by character gen to avoid hitches with file I/O.
|-


'''Function [[PrecacheCharGenClear - Game|PrecacheCharGenClear]]()'''
|[[PrecacheCharGenClear - Game|'''PrecacheCharGenClear'''()]]
*Clears all the previously cached data used by character gen.
|Clears all the previously cached data used by character gen.
|-


'''int Function [[QueryStat - Game|QueryStat]](string asStat)'''
|[[QueryStat - Game|Int '''QueryStat'''(String ''asStat'')]]
*Queries the given stat and returns its value.
|Queries the given stat and returns its value.
|-


'''Function [[QuitToMainMenu - Game|QuitToMainMenu]]()'''
|[[QuitToMainMenu - Game|'''QuitToMainMenu'''()]]
*Forces the game back to the main menu.
|Forces the game back to the main menu.
|-


'''bool Function [[RemoveHavokConstraints - Game|RemoveHavokConstraints]](ObjectReference arFirstRef, string arFirstRefNodeName, ObjectReference arSecondRef, string arSecondRefNodeName)'''
|[[RemoveHavokConstraints - Game|Bool '''RemoveHavokConstraints'''(ObjectReference ''arFirstRef'', String ''arFirstRefNodeName'', ObjectReference ''arSecondRef'', String ''arSecondRefNodeName'')]]
*Removes any constraint between two rigid bodies
|Removes any constraint between two rigid bodies
|-


'''Function [[RequestAutoSave - Game|RequestAutoSave]]()'''
|[[RequestAutoSave - Game|'''RequestAutoSave'''()]]
*Requests for an auto-save to be made.
|Requests for an auto-save to be made.
|-


'''Function [[RequestModel - Game|RequestModel]](string asModelName)'''
|[[RequestModel - Game|'''RequestModel'''(String ''asModelName'')]]
*Requests the specified model.
|Requests the specified model.
|-


'''Function [[RequestSave - Game|RequestSave]]()'''
|[[RequestSave - Game|'''RequestSave'''()]]
*Requests for a normal save to be made.
|Requests for a normal save to be made.
|-


'''Function [[SendWereWolfTransformation - Game|SendWereWolfTransformation]]()'''
|[[SendWereWolfTransformation - Game|'''SendWereWolfTransformation'''()]]
*Finds an actor in high who can detect the player to call werewolf crime on the player
|Finds an actor in high who can detect the player to call werewolf crime on the player
|-


'''Function [[ServeTime - Game|ServeTime]]()'''
|[[ServeTime - Game|'''ServeTime'''()]]
*Has the player serve their jail time.
|Has the player serve their jail time.
|-


'''Function [[SetAllowFlyingMountLandingRequests - Game|SetAllowFlyingMountLandingRequests]](bool abAllow)'''
|[[SetAllowFlyingMountLandingRequests - Game|'''SetAllowFlyingMountLandingRequests'''(Bool ''abAllow'')]]
*Allow or disallow the player requests to have a flying mount land.
|Allow or disallow the player requests to have a flying mount land.
|-


'''Function [[SetBeastForm - Game|SetBeastForm]](bool abEntering)'''
|[[SetBeastForm - Game|'''SetBeastForm'''(Bool ''abEntering'')]]
*Flags the player as being in/out of "beast form".
|Flags the player as being in/out of "beast form".
|-


'''Function [[SetCameraTarget - Game|SetCameraTarget]](Actor arTarget)'''
|[[SetCameraTarget - Game|'''SetCameraTarget'''(Actor ''arTarget'')]]
*Sets the camera target actor
|Sets the camera target actor
|-


'''Function [[SetHudCartMode - Game|SetHudCartMode]](bool abSetCartMode)'''
|[[SetHudCartMode - Game|'''SetHudCartMode'''(Bool ''abSetCartMode'')]]
*Flags the HUD as being in "cart mode" or not.
|Flags the HUD as being in "cart mode" or not.
|-


'''Function [[SetInChargen - Game|SetInChargen]](bool abDisableSaving, bool abDisableWaiting, bool abShowControlsDisabledMessage)'''
|[[SetInChargen - Game|'''SetInChargen'''(Bool ''abDisableSaving'', Bool ''abDisableWaiting'', Bool ''abShowControlsDisabledMessage'')]]
*Enable/disable various functionality which we want in chargen.
|Enable/disable various functionality which we want in chargen.
|-


'''Function [[SetPlayerAIDriven - Game|SetPlayerAIDriven]](bool abAIDriven)'''
|[[SetPlayerAIDriven - Game|'''SetPlayerAIDriven'''(Bool ''abAIDriven'')]]
*Enables or disables the AI driven flag on the player.
|Enables or disables the AI driven flag on the player.
|-


'''Function [[SetPlayerReportCrime - Game|SetPlayerReportCrime]](bool abReportCrime)'''
|[[SetPlayerReportCrime - Game|'''SetPlayerReportCrime'''(Bool ''abReportCrime'')]]
*Set the state of the player as an actor who commits crimes
|Set the state of the player as an actor who commits crimes
|-


'''Function [[SetSittingRotation - Game|SetSittingRotation]](float afValue)'''
|[[SetSittingRotation - Game|'''SetSittingRotation'''(Float ''afValue'')]]
*Set the player's sitting camera offset rotation.
|Set the player's sitting camera offset rotation.
|-


'''Function [[SetSunGazeImageSpaceModifier - Game|SetSunGazeImageSpaceModifier]](ImageSpaceModifier apImod)'''
|[[SetSunGazeImageSpaceModifier - Game|'''SetSunGazeImageSpaceModifier'''(ImageSpaceModifier ''apImod'')]]
*Will cause the specified ImageSpace Modifier to be triggered when the player begins looking at the sun
|Will cause the specified ImageSpace Modifier to be triggered when the player begins looking at the sun
|-


'''Function [[ShakeCamera - Game|ShakeCamera]](ObjectReference akSource, float afStrength)'''
|[[ShakeCamera - Game|'''ShakeCamera'''(ObjectReference ''akSource'', Float ''afStrength'')]]
*Shakes the camera from the specified location with the specified strength.
|Shakes the camera from the specified location with the specified strength.
|-


'''Function [[ShakeController - Game|ShakeController]](float afLeftStrength, float afRightStrength, float afDuration)'''
|[[ShakeController - Game|'''ShakeController'''(Float ''afLeftStrength'', Float ''afRightStrength'', Float ''afDuration'')]]
*Shakes the controller for the specified amount of time.
|Shakes the controller for the specified amount of time.
|-


'''Function [[ShowFirstPersonGeometry - Game|ShowFirstPersonGeometry]](bool abShow)'''
|[[ShowFirstPersonGeometry - Game|'''ShowFirstPersonGeometry'''(Bool ''abShow'')]]
*Shows or hides the first-person geometry
|Shows or hides the first-person geometry
|-


'''Function [[ShowLimitedRaceMenu - Game|ShowLimitedRaceMenu]]()'''
|[[ShowLimitedRaceMenu - Game|'''ShowLimitedRaceMenu'''()]]
*Shows the race/sex change menu, but without the ability to change race or sex.
|Shows the race/sex change menu, but without the ability to change race or sex.
|-


'''Function [[ShowRaceMenu - Game|ShowRaceMenu]]()'''
|[[ShowRaceMenu - Game|'''ShowRaceMenu'''()]]
*Shows the race/sex change menu.
|Shows the race/sex change menu.
|-


'''Function [[ShowTitleSequenceMenu - Game|ShowTitleSequenceMenu]]()'''
|[[ShowTitleSequenceMenu - Game|'''ShowTitleSequenceMenu'''()]]
*Shows the title sequence menu.
|Shows the title sequence menu.
|-


'''Function [[ShowTrainingMenu - Game|ShowTrainingMenu]](Actor aActor)'''
|[[ShowTrainingMenu - Game|'''ShowTrainingMenu'''(Actor ''aActor'')]]
*Shows the training menu provided by actor parameter.
|Shows the training menu provided by actor parameter.
|-


'''Function [[StartTitleSequence - Game|StartTitleSequence]](string asSequenceName)'''
|[[StartTitleSequence - Game|'''StartTitleSequence'''(String ''asSequenceName'')]]
*Plays the specified sequence in the title menu.
|Plays the specified sequence in the title menu.
|-


'''Function [[TeachWord - Game|TeachWord]](WordOfPower akWord)'''
|[[TeachWord - Game|'''TeachWord'''(WordOfPower ''akWord'')]]
*Teaches the specified [[WordOfPower Script|WordOfPower]] to the player
|Teaches the specified [[WordOfPower Script|WordOfPower]] to the player
|-


'''Function [[TriggerScreenBlood - Game|TriggerScreenBlood]](int aiValue)'''
|[[TriggerScreenBlood - Game|'''TriggerScreenBlood'''(Int ''aiValue'')]]
*Trigger on-screen blood splatter.
|Trigger on-screen blood splatter.
|-


'''Function [[UnlockWord - Game|UnlockWord]](WordOfPower akWord)'''
|[[UnlockWord - Game|'''UnlockWord'''(WordOfPower ''akWord'')]]
*Unlocks the specified [[WordOfPower Script|WordOfPower]] so the player can use it
|Unlocks the specified [[WordOfPower Script|WordOfPower]] so the player can use it
|-


'''bool Function [[UsingGamepad - Game|UsingGamepad]]()'''
|[[UsingGamepad - Game|Bool '''UsingGamepad'''()]]
*Returns whether the player is using a gamepad or not.
|Returns whether the player is using a gamepad or not.
|-
 
|}


== SKSE Global Functions ==
== SKSE Global Functions ==
'''int Function [[GetPerkPoints - Game|GetPerkPoints]]()'''
*Returns the number of perk points available to the player.


'''Function [[SetPerkPoints - Game|SetPerkPoints]](int perkPoints)'''
{|class="wikitable" width =100%
*Sets the number of perk points available to the player.
!style="text-align:left;" width=25%|Function
!style="text-align:left;"|Description
|-
|[[AddAchievement - Game|'''AddAchievement'''(Int ''aiAchievementID'')]]
|Adds the specified achievement/trophy to the player's gamer profile.
|-


'''Function [[ModPerkPoints - Game|ModPerkPoints]](int perkPoints)'''
|[[AddPerkPoints - Game|'''AddPerkPoints'''(Int ''aiPerkPoints'')]]
*Changes the number of perk points available to the player by the specified amount.
|Adds the given number of perk points to the player. Clamped at 255.
|-


'''Function [[SetGameSettingBool - Game|SetGameSettingBool]](String setting, bool value)'''
|[[AdvanceSkill - Game|'''AdvanceSkill'''(String ''asSkillName'', Float ''afMagnitude'')]]
*Changes the value of boolean Game Settings.
|Advance the given skill on the player by the provided amount of skill usage
|-


'''Function [[SetGameSettingInt - Game|SetGameSettingInt]](String setting, int value)'''
|[[AddHavokBallAndSocketConstraint - Game|Bool '''AddHavokBallAndSocketConstraint'''(ObjectReference ''arRefA'', String ''arRefANode'', ObjectReference ''arRefB'', String ''arRefBNode'', Float ''afRefALocalOffsetX'', Float ''afRefALocalOffsetY'', Float ''afRefALocalOffsetZ'', Float ''afRefBLocalOffsetX'', Float ''afRefBLocalOffsetY'', Float ''afRefBLocalOffsetZ'')]]
*Changes the value of integer Game Settings.
|Adds a ball-and-socket constraint between two rigid bodies, identified by their ref and node names
|-


'''Function [[SetGameSettingFloat - Game|SetGameSettingFloat]](String setting, float value)'''
|[[CalculateFavorCost - Game|Int '''CalculateFavorCost'''(Int ''aiFavorPrice'')]]
*Changes the value of float Game Settings.
|Calculates how many points the player would have to pay for a favor of the specified price.
|-


'''Function [[SetGameSettingString - Game|SetGameSettingString]](String setting, string value)'''
|[[ClearPrison - Game|'''ClearPrison'''()]]
*Changes the value of string Game Settings.
|Clears all Prison variables on the PlayerCharacter so the game will know he is out of prison.
|-


'''int Function [[GetModCount - Game|GetModCount]]()'''
|[[ClearTempEffects - Game|'''ClearTempEffects'''()]]
*Returns the number of mods currently active.
|Clears all temp effects (such as terrain effects) in the game.
|-


'''string Function [[GetModName - Game|GetModName]](int modIndex)'''
|[[DisablePlayerControls - Game|'''DisablePlayerControls'''(Bool ''abMovement'', Bool ''abFighting'', Bool ''abCamSwitch'', Bool ''abLooking'', Bool ''abSneaking'', Bool ''abMenu'', Bool ''abActivate'', Bool ''abJournalTabs'', Int ''aiDisablePOVType'')]]
*Returns the mods name at the specified index.
|Disables the specified player controls.
|-


'''string Function [[GetModAuthor - Game|GetModAuthor]](int modIndex)'''
|[[EnableFastTravel - Game|'''EnableFastTravel'''(Bool ''abEnable'')]]
*Returns the specified mod's author.
|Enables or disables the player's ability to fast travel.
|-


'''string Function [[GetModDescription - Game|GetModDescription]](int modIndex)'''
|[[EnablePlayerControls - Game|'''EnablePlayerControls'''(Bool ''abMovement'', Bool ''abFighting'', Bool ''abCamSwitch'', Bool ''abLooking'', Bool ''abSneaking'', Bool ''abMenu'', Bool ''abActivate'', Bool ''abJournalTabs'', Int ''aiDisablePOVType'')]]
*Returns the specified mod's description.
|Enables the specified player controls.
|-


'''int Function [[GetModDependencyCount - Game|GetModDependencyCount]](int modIndex)'''
|[[FadeOutGame - Game|'''FadeOutGame'''(Bool ''abFadingOut'', Bool ''abBlackFade'', Float ''afSecsBeforeFade'', Float ''afFadeDuration'')]]
*Returns the dependency count of the specified mod.
|Fades the game in and out with the specified parameters.
|-


'''int Function [[GetNthModDependency - Game|GetNthModDependency]](int modIndex, int n)'''
|[[FastTravel - Game|'''FastTravel'''(ObjectReference ''akDestination'')]]
*Returns the mod index of the specified Dependency.
|Fast-travels the player to the specified object's location.
|-


'''int Function [[GetCameraState - Game|GetCameraState]]()'''
|[[FindClosestActor - Game|Actor '''FindClosestActor'''(Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
*Returns the character's current camera state.(0 - first person;1 - auto vanity;2 - VATS;3 - free;4 - iron sights;5 - furniture;6 - transition;7 - tweenmenu;8 - third person 1;9 - third person 2;10 - horse;11 - bleedout;12 - dragon)
|Finds the closest actor within a given radius of a location
|-


'''Function [[SaveGame - Game|SaveGame]](string name)'''
|[[FindClosestActorFromRef - Game|Actor '''FindClosestActorFromRef'''(ObjectReference ''arCenter'', Float ''afRadius'')]]
*Saves the game with the specified name.
|Finds the closest actor within a given radius of a reference
|-


'''Function [[LoadGame - Game|LoadGame]](string name)'''
|[[FindClosestReferenceOfAnyTypeInList - Game|ObjectReference '''FindClosestReferenceOfAnyTypeInList'''(FormList ''arBaseObjects'', Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
*Loads the save with the specified name.
|Finds the closest reference of any of the base objects in the list within a given radius of a location
|-


'''int Function [[GetNumTintMasks - Game|GetNumTintMasks]]()'''
|[[FindClosestReferenceOfAnyTypeInListFromRef - Game|ObjectReference '''FindClosestReferenceOfAnyTypeInListFromRef'''(FormList ''arBaseObjects'', ObjectReference ''arCenter'', Float ''afRadius'')]]
*Returns the total number of tints for the player.
|Finds the closest reference of any of the base objects in the list within a given radius of a reference
|-


'''int Function [[GetNthTintMaskColor - Game|GetNthTintMaskColor]](int n)'''
|[[FindClosestReferenceOfType - Game|ObjectReference '''FindClosestReferenceOfType'''(Form ''arBaseObject'', Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
*Returns the color of the Nth tint mask.
|Finds the closest reference of a given base object within a given radius of a location
|-


'''int Function [[GetNthTintMaskType - Game|GetNthTintMaskType]](int n)'''
|[[FindClosestReferenceOfTypeFromRef - Game|ObjectReference '''FindClosestReferenceOfTypeFromRef'''(Form ''arBaseObject'', ObjectReference ''arCenter'', Float ''afRadius'')]]
*Returns the type of the Nth tint mask.
|Finds the closest reference of a given base object within a given radius of a reference
|-


'''int Function [[SetNthTintMaskColor - Game|GetNthTintMaskColor]](int n, int color)'''
|[[FindRandomActor - Game|Actor '''FindRandomActor'''(Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
*Sets the color of the Nth tint mask.
|Finds a random actor within a given radius of a location
|-


'''string Function [[GetNthTintMaskTexturePath - Game|GetNthTintMaskTexturePath]](int n)'''
|[[FindRandomActorFromRef - Game|Actor '''FindRandomActorFromRef'''(ObjectReference ''arCenter'', Float ''afRadius'')]]
*Returns the texture path of the Nth tint mask.
|Finds a random actor within a given radius of a reference
|-


'''Function [[SetNthTintMaskTexturePath - Game|SetNthTintMaskTexturePath]](int n)'''
|[[FindRandomReferenceOfAnyTypeInList - Game|ObjectReference '''FindRandomReferenceOfAnyTypeInList'''(FormList ''arBaseObjects'', Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
*Sets the texturepath of the Nth tint mask.
|Finds a random reference of any of the base objects in the list within a given radius of a location
|-


'''int Function [[GetNumTintsByType - Game|GetNumTintsByType]](int type)'''
|[[FindRandomReferenceOfAnyTypeInListFromRef - Game|ObjectReference '''FindRandomReferenceOfAnyTypeInListFromRef'''(FormList ''arBaseObjects'', ObjectReference ''arCenter'', Float ''afRadius'')]]
*Returns how many indexes there are for this type.
|Finds a random reference of any of the base objects in the list within a given radius of a reference
|-


'''int Function [[GetTintMaskColor - Game|GetTintMaskColor]](int type, int index)'''
|[[FindRandomReferenceOfType - Game|ObjectReference '''FindRandomReferenceOfType'''(Form ''arBaseObject'', Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
*Returns the color for the particular tintMask type and index.
|Finds a random reference of a given base object within a given radius of a location
|-


'''Function [[SetTintMaskColor - Game|SetTintMaskColor]](int color, int type, int index)'''
|[[FindRandomReferenceOfTypeFromRef - Game|ObjectReference '''FindRandomReferenceOfTypeFromRef'''(Form ''arBaseObject'', ObjectReference ''arCenter'', Float ''afRadius'')]]
*Sets the tintMask color for the particular type and index
|Finds a random reference of a given base object within a given radius of a reference
|-


'''Function [[UpdateHairColor - Game|UpdateHairColor]]()'''
|[[ForceFirstPerson - Game|'''ForceFirstPerson'''()]]
*Instantly updates the player's hair color.
|Forces the player camera into 1st-person.
|-


== Member Functions ==
|[[ForceThirdPerson - Game|'''ForceThirdPerson'''()]]
None
|Forces the player camera into 3rd-person.
|-


== Events ==
|[[GetForm - Game|Form '''GetForm'''(Int ''aiFormID'')]]
None
|Obtains a [[Form Script|Form]] from the game by its form ID number.
|-
 
|[[GetFormFromFile - Game|Form '''GetFormFromFile'''(Int ''aiFormID'', String ''asFilename'')]]
|Obtains the form specified by its form ID number which originated in the specified file.
|-
 
|[[GetGameSettingFloat - Game|Float '''GetGameSettingFloat'''(String ''asGameSetting'')]]
|Obtains the value of a float game setting.
|-
 
|[[GetGameSettingInt - Game|Float '''GetGameSettingInt'''(String ''asGameSetting'')]]
|Obtains the value of an int game setting.
|-
 
|[[GetGameSettingString - Game|Float '''GetGameSettingString'''(String ''asGameSetting'')]]
|Obtains the value of a string game setting.
|-
 
|[[GetPlayer - Game|Actor '''GetPlayer'''()]]
|Obtains the [[Actor Script|Actor]] that represents the player.
|-
 
|[[GetPlayerGrabbedRef - Game|ObjectReference '''GetPlayerGrabbedRef'''()]]
|Obtains the [[ObjectReference Script|ObjectReference]] the player is currently grabbing.
|-
 
|[[GetPlayersLastRiddenHorse - Game|Actor '''GetPlayersLastRiddenHorse'''()]]
|Gets this actors last ridden horse if it is the player. Returns None if player has not ridden a horse is not the player.
|-
 
|[[GetRealHoursPassed - Game|Float '''GetRealHoursPassed'''()]]
|Returns the number of real-life hours that have passed playing the game.
|-
 
|[[GetSunPositionX - Game|Float '''GetSunPositionX'''()]]
|Gets the X position of the sun.
|-
 
|[[GetSunPositionY - Game|Float '''GetSunPositionY'''()]]
|Gets the Y position of the sun.
|-
 
|[[GetSunPositionZ - Game|Float '''GetSunPositionZ'''()]]
|Gets the Z position of the sun.
|-
 
|[[HideTitleSequenceMenu - Game|'''HideTitleSequenceMenu'''()]]
|Hides the title sequence menu.
|-
 
|[[IncrementSkill - Game|'''IncrementSkill'''(String ''asSkillName'')]]
|Advances the provided Skill by the one point (for the player only).
|-
 
|[[IncrementSkillBy - Game|'''IncrementSkillBy'''(String ''asSkillName'', Int ''aiCount'')]]
|Advances the provided Skill by the given number of points (for the player only).
|-
 
|[[IncrementStat - Game|'''IncrementStat'''(String ''asStatName'', Int ''aiModAmount'')]]
|Modifies the specified MiscStat by the given amount
|-
 
|[[IsActivateControlsEnabled - Game|Bool '''IsActivateControlsEnabled'''()]]
|Are the activation controls enabled?
|-
 
|[[IsCamSwitchControlsEnabled - Game|Bool '''IsCamSwitchControlsEnabled'''()]]
|Are the camera switch controls enabled?
|-
 
|[[IsFastTravelEnabled - Game|Bool '''IsFastTravelEnabled'''()]]
|Is fast travel enabled?
|-
 
|[[IsFastTravelControlsEnabled - Game|Bool '''IsFastTravelControlsEnabled'''()]]
|Are fast travel controls enabled?
|-
 
|[[IsFightingControlsEnabled - Game|Bool '''IsFightingControlsEnabled'''()]]
|Are the fighting controls enabled?
|-
 
|[[IsJournalControlsEnabled - Game|Bool '''IsJournalControlsEnabled'''()]]
|Are the journal menu controls enabled?
|-
 
|[[IsLookingControlsEnabled - Game|Bool '''IsLookingControlsEnabled'''()]]
|Are the looking controls enabled?
|-
 
|[[IsMenuControlsEnabled - Game|Bool '''IsMenuControlsEnabled'''()]]
|Are the menu controls enabled?
|-
 
|[[IsMovementControlsEnabled - Game|Bool '''IsMovementControlsEnabled'''()]]
|Are the movement controls enabled?
|-
 
|[[IsPlayerSungazing - Game|Bool '''IsPlayerSungazing'''()]]
|Checks to the see if the player is looking directly at the sun.
|-
 
|[[IsSneakingControlsEnabled - Game|Bool '''IsSneakingControlsEnabled'''()]]
|Are the sneaking controls enabled?
|-
 
|[[IsWordUnlocked - Game|Bool '''IsWordUnlocked'''(WordOfPower ''akWord'')]]
|Is the word of power unlocked on the player?
|-
 
|[[PlayBink - Game|'''PlayBink'''(String ''asFileName'', Bool ''abInterruptible'', Bool ''abMuteAudio'', Bool ''abMuteMusic'', Bool ''abLetterbox'')]]
|Plays a bink video
|-
 
|[[PrecacheCharGen - Game|'''PrecacheCharGen'''()]]
|Precaches all the data used by character gen to avoid hitches with file I/O.
|-
 
|[[PrecacheCharGenClear - Game|'''PrecacheCharGenClear'''()]]
|Clears all the previously cached data used by character gen.
|-
 
|[[QueryStat - Game|Int '''QueryStat'''(String ''asStat'')]]
|Queries the given stat and returns its value.
|-
 
|[[QuitToMainMenu - Game|'''QuitToMainMenu'''()]]
|Forces the game back to the main menu.
|-
 
|[[RemoveHavokConstraints - Game|Bool '''RemoveHavokConstraints'''(ObjectReference ''arFirstRef'', String ''arFirstRefNodeName'', ObjectReference ''arSecondRef'', String ''arSecondRefNodeName'')]]
|Removes any constraint between two rigid bodies
|-
 
|[[RequestAutoSave - Game|'''RequestAutoSave'''()]]
|Requests for an auto-save to be made.
|-
 
|[[RequestModel - Game|'''RequestModel'''(String ''asModelName'')]]
|Requests the specified model.
|-
 
|[[RequestSave - Game|'''RequestSave'''()]]
|Requests for a normal save to be made.
|-
 
|[[SendWereWolfTransformation - Game|'''SendWereWolfTransformation'''()]]
|Finds an actor in high who can detect the player to call werewolf crime on the player
|-
 
|[[ServeTime - Game|'''ServeTime'''()]]
|Has the player serve their jail time.
|-
 
|[[SetAllowFlyingMountLandingRequests - Game|'''SetAllowFlyingMountLandingRequests'''(Bool ''abAllow'')]]
|Allow or disallow the player requests to have a flying mount land.
|-
 
|[[SetBeastForm - Game|'''SetBeastForm'''(Bool ''abEntering'')]]
|Flags the player as being in/out of "beast form".
|-
 
|[[SetCameraTarget - Game|'''SetCameraTarget'''(Actor ''arTarget'')]]
|Sets the camera target actor
|-
 
|[[SetHudCartMode - Game|'''SetHudCartMode'''(Bool ''abSetCartMode'')]]
|Flags the HUD as being in "cart mode" or not.
|-
 
|[[SetInChargen - Game|'''SetInChargen'''(Bool ''abDisableSaving'', Bool ''abDisableWaiting'', Bool ''abShowControlsDisabledMessage'')]]
|Enable/disable various functionality which we want in chargen.
|-
 
|[[SetPlayerAIDriven - Game|'''SetPlayerAIDriven'''(Bool ''abAIDriven'')]]
|Enables or disables the AI driven flag on the player.
|-
 
|[[SetPlayerReportCrime - Game|'''SetPlayerReportCrime'''(Bool ''abReportCrime'')]]
|Set the state of the player as an actor who commits crimes
|-
 
|[[SetSittingRotation - Game|'''SetSittingRotation'''(Float ''afValue'')]]
|Set the player's sitting camera offset rotation.
|-
 
|[[SetSunGazeImageSpaceModifier - Game|'''SetSunGazeImageSpaceModifier'''(ImageSpaceModifier ''apImod'')]]
|Will cause the specified ImageSpace Modifier to be triggered when the player begins looking at the sun
|-
 
|[[ShakeCamera - Game|'''ShakeCamera'''(ObjectReference ''akSource'', Float ''afStrength'')]]
|Shakes the camera from the specified location with the specified strength.
|-
 
|[[ShakeController - Game|'''ShakeController'''(Float ''afLeftStrength'', Float ''afRightStrength'', Float ''afDuration'')]]
|Shakes the controller for the specified amount of time.
|-
 
|[[ShowFirstPersonGeometry - Game|'''ShowFirstPersonGeometry'''(Bool ''abShow'')]]
|Shows or hides the first-person geometry
|-
 
|[[ShowLimitedRaceMenu - Game|'''ShowLimitedRaceMenu'''()]]
|Shows the race/sex change menu, but without the ability to change race or sex.
|-
 
|[[ShowRaceMenu - Game|'''ShowRaceMenu'''()]]
|Shows the race/sex change menu.
|-
 
|[[ShowTitleSequenceMenu - Game|'''ShowTitleSequenceMenu'''()]]
|Shows the title sequence menu.
|-
 
|[[ShowTrainingMenu - Game|'''ShowTrainingMenu'''(Actor ''aActor'')]]
|Shows the training menu provided by actor parameter.
|-
 
|[[StartTitleSequence - Game|'''StartTitleSequence'''(String ''asSequenceName'')]]
|Plays the specified sequence in the title menu.
|-
 
|[[TeachWord - Game|'''TeachWord'''(WordOfPower ''akWord'')]]
|Teaches the specified [[WordOfPower Script|WordOfPower]] to the player
|-
 
|[[TriggerScreenBlood - Game|'''TriggerScreenBlood'''(Int ''aiValue'')]]
|Trigger on-screen blood splatter.
|-
 
|[[UnlockWord - Game|'''UnlockWord'''(WordOfPower ''akWord'')]]
|Unlocks the specified [[WordOfPower Script|WordOfPower]] so the player can use it
|-
 
|[[UsingGamepad - Game|Bool '''UsingGamepad'''()]]
|Returns whether the player is using a gamepad or not.
|-
 
|[[GetPerkPoints - Game|Int '''GetPerkPoints'''()]]
|Returns the number of perk points available to the player.
|-
 
|[[SetPerkPoints - Game|'''SetPerkPoints'''(Int ''perkPoints'')]]
|Sets the number of perk points available to the player.
|-
 
|[[ModPerkPoints - Game|'''ModPerkPoints'''(Int ''perkPoints'')]]
|Changes the number of perk points available to the player by the specified amount.
|-
 
|[[SetGameSettingBool - Game|'''SetGameSettingBool'''(String ''setting'', Bool ''value'')]]
|Changes the value of boolean Game Settings.
|-
 
|[[SetGameSettingInt - Game|'''SetGameSettingInt'''(String ''setting'', Int ''value'')]]
|Changes the value of integer Game Settings.
|-
 
|[[SetGameSettingFloat - Game|'''SetGameSettingFloat'''(String ''setting'', Float ''value'')]]
|Changes the value of float Game Settings.
|-
 
|[[SetGameSettingString - Game|'''SetGameSettingString'''(String ''setting'', String ''value'')]]
|Changes the value of string Game Settings.
|-
 
|[[GetModCount - Game|Int '''GetModCount'''()]]
|Returns the number of mods currently active.
|-
 
|[[GetModName - Game|String '''GetModName'''(Int ''modIndex'')]]
|Returns the mods name at the specified index.
|-
 
|[[GetModAuthor - Game|String '''GetModAuthor'''(Int ''modIndex'')]]
|Returns the specified mod's author.
|-
 
|[[GetModDescription - Game|String '''GetModDescription'''(Int ''modIndex'')]]
|Returns the specified mod's description.
|-
 
|[[GetModDependencyCount - Game|Int '''GetModDependencyCount'''(Int ''modIndex'')]]
|Returns the dependency count of the specified mod.
|-
 
|[[GetNthModDependency - Game|Int '''GetNthModDependency'''(Int ''modIndex'', Int ''n'')]]
|Returns the mod index of the specified Dependency.
|-
 
|[[GetCameraState - Game|Int '''GetCameraState'''()]]
|Returns the character's current camera state.(0 - first person;1 - auto vanity;2 - VATS;3 - free;4 - iron sights;5 - furniture;6 - transition;7 - tweenmenu;8 - third person 1;9 - third person 2;10 - horse;11 - bleedout;12 - dragon)
|-
 
|[[SaveGame - Game|'''SaveGame'''(String ''name'')]]
|Saves the game with the specified name.
|-
 
|[[LoadGame - Game|'''LoadGame'''(String ''name'')]]
|Loads the save with the specified name.
|-
 
|[[GetNumTintMasks - Game|Int '''GetNumTintMasks'''()]]
|Returns the total number of tints for the player.
|-
 
|[[GetNthTintMaskColor - Game|Int '''GetNthTintMaskColor'''(Int ''n'')]]
|Returns the color of the Nth tint mask.
|-
 
|[[GetNthTintMaskType - Game|Int '''GetNthTintMaskType'''(Int ''n'')]]
|Returns the type of the Nth tint mask.
|-
 
|[[SetNthTintMaskColor - Game|Int '''SetNthTintMaskColor'''(Int ''n'', Int ''color'')]]
|Sets the color of the Nth tint mask.
|-
 
|[[GetNthTintMaskTexturePath - Game|String '''GetNthTintMaskTexturePath'''(Int ''n'')]]
|Returns the texture path of the Nth tint mask.
|-
 
|[[SetNthTintMaskTexturePath - Game|'''SetNthTintMaskTexturePath'''(Int ''n'')]]
|Sets the texturepath of the Nth tint mask.
|-
 
|[[GetNumTintsByType - Game|Int '''GetNumTintsByType'''(Int ''type'')]]
|Returns how many indexes there are for this type.
|-
 
|[[GetTintMaskColor - Game|Int '''GetTintMaskColor'''(Int ''type'', Int ''index'')]]
|Returns the color for the particular tintMask type and index.
|-
 
|[[SetTintMaskColor - Game|'''SetTintMaskColor'''(Int ''color'', Int ''type'', Int ''index'')]]
|Sets the tintMask color for the particular type and index
|-
 
|[[UpdateHairColor - Game|'''UpdateHairColor'''()]]
|Instantly updates the player's hair color.
|-
 
|[[GetSkillLegendaryLevel - Game|Int '''GetSkillLegendaryLevel'''(String ''actorValue'')]]
|Returns the legendary level for the skill
|-
 
|[[SetSkillLegendaryLevel - Game|'''SetSkillLegendaryLevel'''(String ''actorValue'', Int ''level'')]]
|Sets the legendary level for the skill.
|-
 
|}
 
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]

Revision as of 03:07, 24 October 2013

Source: Creation Kit

Extends: None

Flags: Hidden


Collection of game-specific global functions

Definition

ScriptName Game Hidden


Global Functions

Function Description
AddAchievement(Int aiAchievementID) Adds the specified achievement/trophy to the player's gamer profile.
AddPerkPoints(Int aiPerkPoints) Adds the given number of perk points to the player. Clamped at 255.
AdvanceSkill(String asSkillName, Float afMagnitude) Advance the given skill on the player by the provided amount of skill usage
Bool AddHavokBallAndSocketConstraint(ObjectReference arRefA, String arRefANode, ObjectReference arRefB, String arRefBNode, Float afRefALocalOffsetX, Float afRefALocalOffsetY, Float afRefALocalOffsetZ, Float afRefBLocalOffsetX, Float afRefBLocalOffsetY, Float afRefBLocalOffsetZ) Adds a ball-and-socket constraint between two rigid bodies, identified by their ref and node names
Int CalculateFavorCost(Int aiFavorPrice) Calculates how many points the player would have to pay for a favor of the specified price.
ClearPrison() Clears all Prison variables on the PlayerCharacter so the game will know he is out of prison.
ClearTempEffects() Clears all temp effects (such as terrain effects) in the game.
DisablePlayerControls(Bool abMovement, Bool abFighting, Bool abCamSwitch, Bool abLooking, Bool abSneaking, Bool abMenu, Bool abActivate, Bool abJournalTabs, Int aiDisablePOVType) Disables the specified player controls.
EnableFastTravel(Bool abEnable) Enables or disables the player's ability to fast travel.
EnablePlayerControls(Bool abMovement, Bool abFighting, Bool abCamSwitch, Bool abLooking, Bool abSneaking, Bool abMenu, Bool abActivate, Bool abJournalTabs, Int aiDisablePOVType) Enables the specified player controls.
FadeOutGame(Bool abFadingOut, Bool abBlackFade, Float afSecsBeforeFade, Float afFadeDuration) Fades the game in and out with the specified parameters.
FastTravel(ObjectReference akDestination) Fast-travels the player to the specified object's location.
Actor FindClosestActor(Float afX, Float afY, Float afZ, Float afRadius) Finds the closest actor within a given radius of a location
Actor FindClosestActorFromRef(ObjectReference arCenter, Float afRadius) Finds the closest actor within a given radius of a reference
ObjectReference 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 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 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 FindClosestReferenceOfTypeFromRef(Form arBaseObject, ObjectReference arCenter, Float afRadius) Finds the closest reference of a given base object within a given radius of a reference
Actor FindRandomActor(Float afX, Float afY, Float afZ, Float afRadius) Finds a random actor within a given radius of a location
Actor FindRandomActorFromRef(ObjectReference arCenter, Float afRadius) Finds a random actor within a given radius of a reference
ObjectReference 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 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 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 FindRandomReferenceOfTypeFromRef(Form arBaseObject, ObjectReference arCenter, Float afRadius) Finds a random reference of a given base object within a given radius of a reference
ForceFirstPerson() Forces the player camera into 1st-person.
ForceThirdPerson() Forces the player camera into 3rd-person.
Form GetForm(Int aiFormID) Obtains a Form from the game by its form ID number.
Form GetFormFromFile(Int aiFormID, String asFilename) Obtains the form specified by its form ID number which originated in the specified file.
Float GetGameSettingFloat(String asGameSetting) Obtains the value of a float game setting.
Float GetGameSettingInt(String asGameSetting) Obtains the value of an int game setting.
Float GetGameSettingString(String asGameSetting) Obtains the value of a string game setting.
Actor GetPlayer() Obtains the Actor that represents the player.
ObjectReference GetPlayerGrabbedRef() Obtains the ObjectReference the player is currently grabbing.
Actor GetPlayersLastRiddenHorse() Gets this actors last ridden horse if it is the player. Returns None if player has not ridden a horse is not the player.
Float GetRealHoursPassed() Returns the number of real-life hours that have passed playing the game.
Float GetSunPositionX() Gets the X position of the sun.
Float GetSunPositionY() Gets the Y position of the sun.
Float GetSunPositionZ() Gets the Z position of the sun.
HideTitleSequenceMenu() Hides the title sequence menu.
IncrementSkill(String asSkillName) Advances the provided Skill by the one point (for the player only).
IncrementSkillBy(String asSkillName, Int aiCount) Advances the provided Skill by the given number of points (for the player only).
IncrementStat(String asStatName, Int aiModAmount) Modifies the specified MiscStat by the given amount
Bool IsActivateControlsEnabled() Are the activation controls enabled?
Bool IsCamSwitchControlsEnabled() Are the camera switch controls enabled?
Bool IsFastTravelEnabled() Is fast travel enabled?
Bool IsFastTravelControlsEnabled() Are fast travel controls enabled?
Bool IsFightingControlsEnabled() Are the fighting controls enabled?
Bool IsJournalControlsEnabled() Are the journal menu controls enabled?
Bool IsLookingControlsEnabled() Are the looking controls enabled?
Bool IsMenuControlsEnabled() Are the menu controls enabled?
Bool IsMovementControlsEnabled() Are the movement controls enabled?
Bool IsPlayerSungazing() Checks to the see if the player is looking directly at the sun.
Bool IsSneakingControlsEnabled() Are the sneaking controls enabled?
Bool IsWordUnlocked(WordOfPower akWord) Is the word of power unlocked on the player?
PlayBink(String asFileName, Bool abInterruptible, Bool abMuteAudio, Bool abMuteMusic, Bool abLetterbox) Plays a bink video
PrecacheCharGen() Precaches all the data used by character gen to avoid hitches with file I/O.
PrecacheCharGenClear() Clears all the previously cached data used by character gen.
Int QueryStat(String asStat) Queries the given stat and returns its value.
QuitToMainMenu() Forces the game back to the main menu.
Bool RemoveHavokConstraints(ObjectReference arFirstRef, String arFirstRefNodeName, ObjectReference arSecondRef, String arSecondRefNodeName) Removes any constraint between two rigid bodies
RequestAutoSave() Requests for an auto-save to be made.
RequestModel(String asModelName) Requests the specified model.
RequestSave() Requests for a normal save to be made.
SendWereWolfTransformation() Finds an actor in high who can detect the player to call werewolf crime on the player
ServeTime() Has the player serve their jail time.
SetAllowFlyingMountLandingRequests(Bool abAllow) Allow or disallow the player requests to have a flying mount land.
SetBeastForm(Bool abEntering) Flags the player as being in/out of "beast form".
SetCameraTarget(Actor arTarget) Sets the camera target actor
SetHudCartMode(Bool abSetCartMode) Flags the HUD as being in "cart mode" or not.
SetInChargen(Bool abDisableSaving, Bool abDisableWaiting, Bool abShowControlsDisabledMessage) Enable/disable various functionality which we want in chargen.
SetPlayerAIDriven(Bool abAIDriven) Enables or disables the AI driven flag on the player.
SetPlayerReportCrime(Bool abReportCrime) Set the state of the player as an actor who commits crimes
SetSittingRotation(Float afValue) Set the player's sitting camera offset rotation.
SetSunGazeImageSpaceModifier(ImageSpaceModifier apImod) Will cause the specified ImageSpace Modifier to be triggered when the player begins looking at the sun
ShakeCamera(ObjectReference akSource, Float afStrength) Shakes the camera from the specified location with the specified strength.
ShakeController(Float afLeftStrength, Float afRightStrength, Float afDuration) Shakes the controller for the specified amount of time.
ShowFirstPersonGeometry(Bool abShow) Shows or hides the first-person geometry
ShowLimitedRaceMenu() Shows the race/sex change menu, but without the ability to change race or sex.
ShowRaceMenu() Shows the race/sex change menu.
ShowTitleSequenceMenu() Shows the title sequence menu.
ShowTrainingMenu(Actor aActor) Shows the training menu provided by actor parameter.
StartTitleSequence(String asSequenceName) Plays the specified sequence in the title menu.
TeachWord(WordOfPower akWord) Teaches the specified WordOfPower to the player
TriggerScreenBlood(Int aiValue) Trigger on-screen blood splatter.
UnlockWord(WordOfPower akWord) Unlocks the specified WordOfPower so the player can use it
Bool UsingGamepad() Returns whether the player is using a gamepad or not.

SKSE Global Functions

Function Description
AddAchievement(Int aiAchievementID) Adds the specified achievement/trophy to the player's gamer profile.
AddPerkPoints(Int aiPerkPoints) Adds the given number of perk points to the player. Clamped at 255.
AdvanceSkill(String asSkillName, Float afMagnitude) Advance the given skill on the player by the provided amount of skill usage
Bool AddHavokBallAndSocketConstraint(ObjectReference arRefA, String arRefANode, ObjectReference arRefB, String arRefBNode, Float afRefALocalOffsetX, Float afRefALocalOffsetY, Float afRefALocalOffsetZ, Float afRefBLocalOffsetX, Float afRefBLocalOffsetY, Float afRefBLocalOffsetZ) Adds a ball-and-socket constraint between two rigid bodies, identified by their ref and node names
Int CalculateFavorCost(Int aiFavorPrice) Calculates how many points the player would have to pay for a favor of the specified price.
ClearPrison() Clears all Prison variables on the PlayerCharacter so the game will know he is out of prison.
ClearTempEffects() Clears all temp effects (such as terrain effects) in the game.
DisablePlayerControls(Bool abMovement, Bool abFighting, Bool abCamSwitch, Bool abLooking, Bool abSneaking, Bool abMenu, Bool abActivate, Bool abJournalTabs, Int aiDisablePOVType) Disables the specified player controls.
EnableFastTravel(Bool abEnable) Enables or disables the player's ability to fast travel.
EnablePlayerControls(Bool abMovement, Bool abFighting, Bool abCamSwitch, Bool abLooking, Bool abSneaking, Bool abMenu, Bool abActivate, Bool abJournalTabs, Int aiDisablePOVType) Enables the specified player controls.
FadeOutGame(Bool abFadingOut, Bool abBlackFade, Float afSecsBeforeFade, Float afFadeDuration) Fades the game in and out with the specified parameters.
FastTravel(ObjectReference akDestination) Fast-travels the player to the specified object's location.
Actor FindClosestActor(Float afX, Float afY, Float afZ, Float afRadius) Finds the closest actor within a given radius of a location
Actor FindClosestActorFromRef(ObjectReference arCenter, Float afRadius) Finds the closest actor within a given radius of a reference
ObjectReference 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 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 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 FindClosestReferenceOfTypeFromRef(Form arBaseObject, ObjectReference arCenter, Float afRadius) Finds the closest reference of a given base object within a given radius of a reference
Actor FindRandomActor(Float afX, Float afY, Float afZ, Float afRadius) Finds a random actor within a given radius of a location
Actor FindRandomActorFromRef(ObjectReference arCenter, Float afRadius) Finds a random actor within a given radius of a reference
ObjectReference 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 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 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 FindRandomReferenceOfTypeFromRef(Form arBaseObject, ObjectReference arCenter, Float afRadius) Finds a random reference of a given base object within a given radius of a reference
ForceFirstPerson() Forces the player camera into 1st-person.
ForceThirdPerson() Forces the player camera into 3rd-person.
Form GetForm(Int aiFormID) Obtains a Form from the game by its form ID number.
Form GetFormFromFile(Int aiFormID, String asFilename) Obtains the form specified by its form ID number which originated in the specified file.
Float GetGameSettingFloat(String asGameSetting) Obtains the value of a float game setting.
Float GetGameSettingInt(String asGameSetting) Obtains the value of an int game setting.
Float GetGameSettingString(String asGameSetting) Obtains the value of a string game setting.
Actor GetPlayer() Obtains the Actor that represents the player.
ObjectReference GetPlayerGrabbedRef() Obtains the ObjectReference the player is currently grabbing.
Actor GetPlayersLastRiddenHorse() Gets this actors last ridden horse if it is the player. Returns None if player has not ridden a horse is not the player.
Float GetRealHoursPassed() Returns the number of real-life hours that have passed playing the game.
Float GetSunPositionX() Gets the X position of the sun.
Float GetSunPositionY() Gets the Y position of the sun.
Float GetSunPositionZ() Gets the Z position of the sun.
HideTitleSequenceMenu() Hides the title sequence menu.
IncrementSkill(String asSkillName) Advances the provided Skill by the one point (for the player only).
IncrementSkillBy(String asSkillName, Int aiCount) Advances the provided Skill by the given number of points (for the player only).
IncrementStat(String asStatName, Int aiModAmount) Modifies the specified MiscStat by the given amount
Bool IsActivateControlsEnabled() Are the activation controls enabled?
Bool IsCamSwitchControlsEnabled() Are the camera switch controls enabled?
Bool IsFastTravelEnabled() Is fast travel enabled?
Bool IsFastTravelControlsEnabled() Are fast travel controls enabled?
Bool IsFightingControlsEnabled() Are the fighting controls enabled?
Bool IsJournalControlsEnabled() Are the journal menu controls enabled?
Bool IsLookingControlsEnabled() Are the looking controls enabled?
Bool IsMenuControlsEnabled() Are the menu controls enabled?
Bool IsMovementControlsEnabled() Are the movement controls enabled?
Bool IsPlayerSungazing() Checks to the see if the player is looking directly at the sun.
Bool IsSneakingControlsEnabled() Are the sneaking controls enabled?
Bool IsWordUnlocked(WordOfPower akWord) Is the word of power unlocked on the player?
PlayBink(String asFileName, Bool abInterruptible, Bool abMuteAudio, Bool abMuteMusic, Bool abLetterbox) Plays a bink video
PrecacheCharGen() Precaches all the data used by character gen to avoid hitches with file I/O.
PrecacheCharGenClear() Clears all the previously cached data used by character gen.
Int QueryStat(String asStat) Queries the given stat and returns its value.
QuitToMainMenu() Forces the game back to the main menu.
Bool RemoveHavokConstraints(ObjectReference arFirstRef, String arFirstRefNodeName, ObjectReference arSecondRef, String arSecondRefNodeName) Removes any constraint between two rigid bodies
RequestAutoSave() Requests for an auto-save to be made.
RequestModel(String asModelName) Requests the specified model.
RequestSave() Requests for a normal save to be made.
SendWereWolfTransformation() Finds an actor in high who can detect the player to call werewolf crime on the player
ServeTime() Has the player serve their jail time.
SetAllowFlyingMountLandingRequests(Bool abAllow) Allow or disallow the player requests to have a flying mount land.
SetBeastForm(Bool abEntering) Flags the player as being in/out of "beast form".
SetCameraTarget(Actor arTarget) Sets the camera target actor
SetHudCartMode(Bool abSetCartMode) Flags the HUD as being in "cart mode" or not.
SetInChargen(Bool abDisableSaving, Bool abDisableWaiting, Bool abShowControlsDisabledMessage) Enable/disable various functionality which we want in chargen.
SetPlayerAIDriven(Bool abAIDriven) Enables or disables the AI driven flag on the player.
SetPlayerReportCrime(Bool abReportCrime) Set the state of the player as an actor who commits crimes
SetSittingRotation(Float afValue) Set the player's sitting camera offset rotation.
SetSunGazeImageSpaceModifier(ImageSpaceModifier apImod) Will cause the specified ImageSpace Modifier to be triggered when the player begins looking at the sun
ShakeCamera(ObjectReference akSource, Float afStrength) Shakes the camera from the specified location with the specified strength.
ShakeController(Float afLeftStrength, Float afRightStrength, Float afDuration) Shakes the controller for the specified amount of time.
ShowFirstPersonGeometry(Bool abShow) Shows or hides the first-person geometry
ShowLimitedRaceMenu() Shows the race/sex change menu, but without the ability to change race or sex.
ShowRaceMenu() Shows the race/sex change menu.
ShowTitleSequenceMenu() Shows the title sequence menu.
ShowTrainingMenu(Actor aActor) Shows the training menu provided by actor parameter.
StartTitleSequence(String asSequenceName) Plays the specified sequence in the title menu.
TeachWord(WordOfPower akWord) Teaches the specified WordOfPower to the player
TriggerScreenBlood(Int aiValue) Trigger on-screen blood splatter.
UnlockWord(WordOfPower akWord) Unlocks the specified WordOfPower so the player can use it
Bool UsingGamepad() Returns whether the player is using a gamepad or not.
Int GetPerkPoints() Returns the number of perk points available to the player.
SetPerkPoints(Int perkPoints) Sets the number of perk points available to the player.
ModPerkPoints(Int perkPoints) Changes the number of perk points available to the player by the specified amount.
SetGameSettingBool(String setting, Bool value) Changes the value of boolean Game Settings.
SetGameSettingInt(String setting, Int value) Changes the value of integer Game Settings.
SetGameSettingFloat(String setting, Float value) Changes the value of float Game Settings.
SetGameSettingString(String setting, String value) Changes the value of string Game Settings.
Int GetModCount() Returns the number of mods currently active.
String GetModName(Int modIndex) Returns the mods name at the specified index.
String GetModAuthor(Int modIndex) Returns the specified mod's author.
String GetModDescription(Int modIndex) Returns the specified mod's description.
Int GetModDependencyCount(Int modIndex) Returns the dependency count of the specified mod.
Int GetNthModDependency(Int modIndex, Int n) Returns the mod index of the specified Dependency.
Int GetCameraState() Returns the character's current camera state.(0 - first person;1 - auto vanity;2 - VATS;3 - free;4 - iron sights;5 - furniture;6 - transition;7 - tweenmenu;8 - third person 1;9 - third person 2;10 - horse;11 - bleedout;12 - dragon)
SaveGame(String name) Saves the game with the specified name.
LoadGame(String name) Loads the save with the specified name.
Int GetNumTintMasks() Returns the total number of tints for the player.
Int GetNthTintMaskColor(Int n) Returns the color of the Nth tint mask.
Int GetNthTintMaskType(Int n) Returns the type of the Nth tint mask.
Int SetNthTintMaskColor(Int n, Int color) Sets the color of the Nth tint mask.
String GetNthTintMaskTexturePath(Int n) Returns the texture path of the Nth tint mask.
SetNthTintMaskTexturePath(Int n) Sets the texturepath of the Nth tint mask.
Int GetNumTintsByType(Int type) Returns how many indexes there are for this type.
Int GetTintMaskColor(Int type, Int index) Returns the color for the particular tintMask type and index.
SetTintMaskColor(Int color, Int type, Int index) Sets the tintMask color for the particular type and index
UpdateHairColor() Instantly updates the player's hair color.
Int GetSkillLegendaryLevel(String actorValue) Returns the legendary level for the skill
SetSkillLegendaryLevel(String actorValue, Int level) Sets the legendary level for the skill.
Retrieved from "https://ck.uesp.net/w/index.php?title=Game_Script&oldid=10330"