Difference between revisions of "Game Script"

Jump to navigation Jump to search

Game Script (edit)

Revision as of 06:36, 7 June 2020

1,415 bytes added ,  06:36, 7 June 2020
→‎SKSE Global Functions: Added IsPluginInstalled
imported>CraftySentinel
(→‎SKSE Global Functions: Should now contain all SKSE functions upto 1.06.16)
imported>Pickysaurus
(→‎SKSE Global Functions: Added IsPluginInstalled)
 
(9 intermediate revisions by 6 users not shown)
Line 1: Line 1:
'''Source:''' Creation Kit
'''Extends:''' None
'''Extends:''' None


'''Flags:''' [[Flag Reference|Hidden]]
Collection of game-specific global functions


Collection of game-specific global functions


== Definition ==
== Definition ==
Line 17: Line 12:
== Global Functions ==
== Global Functions ==


{|class="wikitable" width =100%
:'''[[AddAchievement - Game|AddAchievement]](Int ''aiAchievementID'')'''
!style="text-align:left;" width=25%|Function
:*Adds the specified achievement/trophy to the player's gamer profile.
!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'')]]
:'''[[AddPerkPoints - Game|AddPerkPoints]](Int ''aiPerkPoints'')'''
|Adds the given number of perk points to the player. Clamped at 255.
:*Adds the given number of perk points to the player. Clamped at 255.
|-


|[[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
|-


|[[AddHavokBallAndSocketConstraint - Game|Bool '''AddHavokBallAndSocketConstraint'''(ObjectReference ''arRefA'', String ''arRefANode'', ObjectReference ''arRefB'', String ''arRefBNode'', Float ''afRefALocalOffsetX'', Float ''afRefALocalOffsetY'', Float ''afRefALocalOffsetZ'', Float ''afRefBLocalOffsetX'', Float ''afRefBLocalOffsetY'', Float ''afRefBLocalOffsetZ'')]]
:'''Bool [[AddHavokBallAndSocketConstraint - Game|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
|-


|[[CalculateFavorCost - Game|Int '''CalculateFavorCost'''(Int ''aiFavorPrice'')]]
:'''Int [[CalculateFavorCost - Game|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.
|-


|[[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.
|-


|[[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.
|-


|[[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.
|-


|[[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.
|-


|[[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.
|-


|[[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.
|-


|[[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.
|-


|[[FindClosestActor - Game|Actor '''FindClosestActor'''(Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
:'''Actor [[FindClosestActor - Game|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
|-


|[[FindClosestActorFromRef - Game|Actor '''FindClosestActorFromRef'''(ObjectReference ''arCenter'', Float ''afRadius'')]]
:'''Actor [[FindClosestActorFromRef - Game|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
|-


|[[FindClosestReferenceOfAnyTypeInList - Game|ObjectReference '''FindClosestReferenceOfAnyTypeInList'''(FormList ''arBaseObjects'', Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
:'''ObjectReference [[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
:*Finds the closest reference of any of the base objects in the list within a given radius of a location
|-


|[[FindClosestReferenceOfAnyTypeInListFromRef - Game|ObjectReference '''FindClosestReferenceOfAnyTypeInListFromRef'''(FormList ''arBaseObjects'', ObjectReference ''arCenter'', Float ''afRadius'')]]
:'''ObjectReference [[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
:*Finds the closest reference of any of the base objects in the list within a given radius of a reference
|-


|[[FindClosestReferenceOfType - Game|ObjectReference '''FindClosestReferenceOfType'''(Form ''arBaseObject'', Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
:'''ObjectReference [[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
:*Finds the closest reference of a given base object within a given radius of a location
|-


|[[FindClosestReferenceOfTypeFromRef - Game|ObjectReference '''FindClosestReferenceOfTypeFromRef'''(Form ''arBaseObject'', ObjectReference ''arCenter'', Float ''afRadius'')]]
:'''ObjectReference [[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
:*Finds the closest reference of a given base object within a given radius of a reference
|-


|[[FindRandomActor - Game|Actor '''FindRandomActor'''(Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
:'''Actor [[FindRandomActor - Game|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
|-


|[[FindRandomActorFromRef - Game|Actor '''FindRandomActorFromRef'''(ObjectReference ''arCenter'', Float ''afRadius'')]]
:'''Actor [[FindRandomActorFromRef - Game|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
|-


|[[FindRandomReferenceOfAnyTypeInList - Game|ObjectReference '''FindRandomReferenceOfAnyTypeInList'''(FormList ''arBaseObjects'', Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
:'''ObjectReference [[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
:*Finds a random reference of any of the base objects in the list within a given radius of a location
|-


|[[FindRandomReferenceOfAnyTypeInListFromRef - Game|ObjectReference '''FindRandomReferenceOfAnyTypeInListFromRef'''(FormList ''arBaseObjects'', ObjectReference ''arCenter'', Float ''afRadius'')]]
:'''ObjectReference [[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
:*Finds a random reference of any of the base objects in the list within a given radius of a reference
|-


|[[FindRandomReferenceOfType - Game|ObjectReference '''FindRandomReferenceOfType'''(Form ''arBaseObject'', Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
:'''ObjectReference [[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
:*Finds a random reference of a given base object within a given radius of a location
|-


|[[FindRandomReferenceOfTypeFromRef - Game|ObjectReference '''FindRandomReferenceOfTypeFromRef'''(Form ''arBaseObject'', ObjectReference ''arCenter'', Float ''afRadius'')]]
:'''ObjectReference [[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
:*Finds a random reference of a given base object within a given radius of a reference
|-


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


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


|[[GetForm - Game|Form '''GetForm'''(Int ''aiFormID'')]]
:'''Form [[GetForm - Game|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.
|-


|[[GetFormFromFile - Game|Form '''GetFormFromFile'''(Int ''aiFormID'', String ''asFilename'')]]
:'''Form [[GetFormFromFile - Game|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.
|-


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


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


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


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


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


|[[GetPlayersLastRiddenHorse - Game|Actor '''GetPlayersLastRiddenHorse'''()]]
:'''Actor [[GetPlayersLastRiddenHorse - Game|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.
|-


|[[GetRealHoursPassed - Game|Float '''GetRealHoursPassed'''()]]
:'''Float [[GetRealHoursPassed - Game|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.
|-


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


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


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


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


|[[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).
|-


|[[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).
|-


|[[IncrementStat - Game|'''IncrementStat'''(String ''asStatName'', Int ''aiModAmount'')]]
:'''[[IncrementStat - Game|IncrementStat]](String ''asStatName'', Int ''aiModAmount'')'''
|Modifies the specified MiscStat by the given amount
:*Modifies the specified MiscStat by the given amount
|-


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


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


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


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


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


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


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


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


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


|[[IsPlayerSungazing - Game|Bool '''IsPlayerSungazing'''()]]
:'''Bool [[IsPlayerSungazing - Game|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.
|-


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


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


|[[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
|-


|[[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.
|-


|[[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.
|-


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


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


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


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


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


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


|[[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
|-


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


|[[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.
|-


|[[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".
|-


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


|[[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.
|-


|[[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.
|-


|[[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.
|-


|[[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
|-


|[[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.
|-


|[[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
|-


|[[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.
|-


|[[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.
|-


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


|[[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.
|-


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


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


|[[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.
|-


|[[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.
|-


|[[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
|-


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


|[[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
|-


|[[UsingGamepad - Game|Bool '''UsingGamepad'''()]]
:'''Bool [[UsingGamepad - Game|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 ==


{|class="wikitable" width =100%
:'''Int [[GetPerkPoints - Game|GetPerkPoints]]()'''
!style="text-align:left;" width=25%|Function
:*Returns the number of perk points available to the player.
!style="text-align:left;"|Description
 
|-
:'''[[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.
 
:'''Int [[GetModCount - Game|GetModCount]]()'''
:*Returns the number of mods currently active.
 
:'''Int [[GetModByName - Game|GetModByName]](String ''name'')'''
:*Returns the index of the specified mod.
 
:'''String [[GetModName - Game|GetModName]](Int ''modIndex'')'''
:*Returns the mods name at the specified index.
 
:'''String [[GetModAuthor - Game|GetModAuthor]](Int ''modIndex'')'''
:*Returns the specified mod's author.
 
:'''String [[GetModDescription - Game|GetModDescription]](Int ''modIndex'')'''
:*Returns the specified mod's description.
 
:'''Int [[GetModDependencyCount - Game|GetModDependencyCount]](Int ''modIndex'')'''
:*Returns the dependency count of the specified mod.
 
:'''Int [[GetNthModDependency - Game|GetNthModDependency]](Int ''modIndex'', Int ''n'')'''
:*Returns the mod index of the specified Dependency.
 
:'''Bool [[IsPluginInstalled - Game|IsPluginInstalled]](String ''name'')'''
:*Returns if the named mod is found in the load order.
 
:'''Int [[GetLightModCount - Game|GetLightModCount]]()'''
:*Returns the number of light mods currently active.
 
:'''Int [[GetLightModByName - Game|GetLightModByName]](String ''name'')'''
:*Returns the index of the specified light mod.


|[[GetPerkPoints - Game|Int '''GetPerkPoints'''()]]
:'''String [[GetLightModName - Game|GetLightModName]](Int ''modIndex'')'''
|Returns the number of perk points available to the player.
:*Returns the light mod's name at the specified index.
|-


|[[SetPerkPoints - Game|'''SetPerkPoints'''(Int ''perkPoints'')]]
:'''String [[GetLightModAuthor - Game|GetLightModAuthor]](Int ''modIndex'')'''
|Sets the number of perk points available to the player.
:*Returns the specified light mod's author.
|-


|[[ModPerkPoints - Game|'''ModPerkPoints'''(Int ''perkPoints'')]]
:'''String [[GetLightModDescription - Game|GetLightModDescription]](Int ''modIndex'')'''
|Changes the number of perk points available to the player by the specified amount.
:*Returns the specified light mod's description.
|-


|[[GetModCount - Game|Int '''GetModCount'''()]]
:'''Int [[GetLightModDependencyCount - Game|GetLightModDependencyCount]](Int ''modIndex'')'''
|Returns the number of mods currently active.
:*Returns the dependency count of the specified light mod.
|-


|[[GetModByName - Game|Int '''GetModByName'''(String ''name'')]]
:'''Int [[GetNthLightModDependency - Game|GetNthLightModDependency]](Int ''modIndex'', Int ''n'')'''
|Returns the index of the specified mod.
:*Returns the mod index of the specified Dependency.
|-


|[[GetModName - Game|String '''GetModName'''(Int ''modIndex'')]]
:'''[[SetGameSettingFloat - Game|SetGameSettingFloat]](String ''setting'', Float ''value'')'''
|Returns the mods name at the specified index.
:*Changes the value of float Game Settings.
|-


|[[GetModAuthor - Game|String '''GetModAuthor'''(Int ''modIndex'')]]
:'''[[SetGameSettingInt - Game|SetGameSettingInt]](String ''setting'', Int ''value'')'''
|Returns the specified mod's author.
:*Changes the value of integer Game Settings.
|-


|[[GetModDescription - Game|String '''GetModDescription'''(Int ''modIndex'')]]
:'''[[SetGameSettingBool - Game|SetGameSettingBool]](String ''setting'', Bool ''value'')'''
|Returns the specified mod's description.
:*Changes the value of boolean Game Settings.
|-


|[[GetModDependencyCount - Game|Int '''GetModDependencyCount'''(Int ''modIndex'')]]
:'''[[SetGameSettingString - Game|SetGameSettingString]](String ''setting'', String ''value'')'''
|Returns the dependency count of the specified mod.
:*Changes the value of string Game Settings.
|-


|[[GetNthModDependency - Game|Int '''GetNthModDependency'''(Int ''modIndex'', Int ''n'')]]
:'''[[SaveGame - Game|SaveGame]](String ''name'')'''
|Returns the mod index of the specified Dependency.
:*Saves the game with the specified name.
|-


|[[SetGameSettingFloat - Game|'''SetGameSettingFloat'''(String ''setting'', Float ''value'')]]
:'''[[LoadGame - Game|LoadGame]](String ''name'')'''
|Changes the value of float Game Settings.
:*Loads the save with the specified name.
|-


|[[SetGameSettingInt - Game|'''SetGameSettingInt'''(String ''setting'', Int ''value'')]]
:'''Int [[GetNumTintMasks - Game|GetNumTintMasks]]()'''
|Changes the value of integer Game Settings.
:*Returns the total number of tints for the player.
|-


|[[SetGameSettingBool - Game|'''SetGameSettingBool'''(String ''setting'', Bool ''value'')]]
:'''Int [[GetNthTintMaskColor - Game|GetNthTintMaskColor]](Int ''n'')'''
|Changes the value of boolean Game Settings.
:*Returns the color of the Nth tint mask.
|-


|[[SetGameSettingString - Game|'''SetGameSettingString'''(String ''setting'', String ''value'')]]
:'''Int [[GetNthTintMaskType - Game|GetNthTintMaskType]](Int ''n'')'''
|Changes the value of string Game Settings.
:*Returns the type of the Nth tint mask.
|-


|[[SaveGame - Game|'''SaveGame'''(String ''name'')]]
:'''Int [[SetNthTintMaskColor - Game|SetNthTintMaskColor]](Int ''n'', Int ''color'')'''
|Saves the game with the specified name.
:*Sets the color of the Nth tint mask.
|-


|[[LoadGame - Game|'''LoadGame'''(String ''name'')]]
:'''String [[GetNthTintMaskTexturePath - Game|GetNthTintMaskTexturePath]](Int ''n'')'''
|Loads the save with the specified name.
:*Returns the texture path of the Nth tint mask.
|-


|[[GetNumTintMasks - Game|Int '''GetNumTintMasks'''()]]
:'''[[SetNthTintMaskTexturePath - Game|SetNthTintMaskTexturePath]](String ''path'', Int ''n'')'''
|Returns the total number of tints for the player.
:*Sets the texturepath of the Nth tint mask.
|-


|[[GetNthTintMaskColor - Game|Int '''GetNthTintMaskColor'''(Int ''n'')]]
:'''Int [[GetNumTintsByType - Game|GetNumTintsByType]](Int ''type'')'''
|Returns the color of the Nth tint mask.
:*Returns how many indexes there are for this type.
|-


|[[GetNthTintMaskType - Game|Int '''GetNthTintMaskType'''(Int ''n'')]]
:'''Int [[GetTintMaskColor - Game|GetTintMaskColor]](Int ''type'', Int ''index'')'''
|Returns the type of the Nth tint mask.
:*Returns the color for the particular tintMask type and index.
|-


|[[SetNthTintMaskColor - Game|Int '''SetNthTintMaskColor'''(Int ''n'', Int ''color'')]]
:'''[[SetTintMaskColor - Game|SetTintMaskColor]](Int ''color'', Int ''type'', Int ''index'')'''
|Sets the color of the Nth tint mask.
:*Sets the tintMask color for the particular type and index.
|-


|[[GetNthTintMaskTexturePath - Game|String '''GetNthTintMaskTexturePath'''(Int ''n'')]]
:'''String [[GetTintMaskTexturePath - Game|GetTintMaskTexturePath]](Int ''type'', Int ''index'')'''
|Returns the texture path of the Nth tint mask.
:*Returns the tintMask texture for the particular type and index.
|-


|[[SetNthTintMaskTexturePath - Game|'''SetNthTintMaskTexturePath'''(String ''path'', Int ''n'')]]
:'''[[SetTintMaskTexturePath - Game|SetTintMaskTexturePath]](String ''path'', Int ''type'', Int ''index'')'''
|Sets the texturepath of the Nth tint mask.
:*Sets the tintMask texture for the particular type and index.
|-


|[[GetNumTintsByType - Game|Int '''GetNumTintsByType'''(Int ''type'')]]
:'''[[UpdateTintMaskColors - Game|UpdateTintMaskColors]]()'''
|Returns how many indexes there are for this type.
:*Updates Tint Mask colors without updating the entire model.
|-


|[[GetTintMaskColor - Game|Int '''GetTintMaskColor'''(Int ''type'', Int ''index'')]]
:'''[[UpdateHairColor - Game|UpdateHairColor]]()'''
|Returns the color for the particular tintMask type and index.
:*Instantly updates the player's hair color.
|-


|[[SetTintMaskColor - Game|'''SetTintMaskColor'''(Int ''color'', Int ''type'', Int ''index'')]]
:'''Int [[GetCameraState - Game|GetCameraState]]()'''
|Sets the tintMask color for the particular type and index.
:*Returns the character's current camera state.
|-


|[[GetTintMaskTexturePath - Game|String '''GetTintMaskTexturePath'''(Int ''type'', Int ''index'')]]
:'''[[SetMiscStat - Game|SetMiscStat]](String ''name'', Int ''value'')'''
|Returns the tintMask texture for the particular type and index.
:*Sets the Misc Stat to the specified value.
|-


|[[SetTintMaskTexturePath - Game|'''SetTintMaskTexturePath'''(String ''path'', Int ''type'', Int ''index'')]]
:'''[[SetPlayersLastRiddenHorse - Game|SetPlayersLastRiddenHorse]](Actor ''horse'')'''
|Sets the tintMask texture for the particular type and index.
:*Sets the players last ridden horse, None will clear the last ridden horse.
|-


|[[UpdateTintMaskColors - Game|'''UpdateTintMaskColors'''()]]
:'''Int [[GetSkillLegendaryLevel - Game|GetSkillLegendaryLevel]](String ''actorValue'')'''
|Updates Tint Mask colors without updating the entire model.
:*Returns the legendary level for the skill. -1 indicates that the skill cannot have a legendary level. ''This is marked as deprecated in SKSE's Game.psc.''
|-


|[[UpdateHairColor - Game|'''UpdateHairColor'''()]]
:'''[[SetSkillLegendaryLevel - Game|SetSkillLegendaryLevel]](String ''actorValue'', Int ''level'')'''
|Instantly updates the player's hair color.
:*Sets the legendary level for the skill. ''This is marked as deprecated in SKSE's Game.psc.''
|-


|[[GetCameraState - Game|Int '''GetCameraState'''()]]
:'''Float [[GetPlayerExperience - Game|GetPlayerExperience]]()'''
|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)
:*Returns the players experience for this level (not total experience).
|-


|[[SetMiscStat - Game|'''SetMiscStat'''(String ''name'', Int ''value'')]]
:'''[[SetPlayerExperience - Game|SetPlayerExperience]](Float ''exp'')'''
|Sets the Misc Stat to the specified value.
:*Sets the player's experience to the specified amount (This will not trigger a level up notification)
|-


|[[SetPlayersLastRiddenHorse - Game|'''SetPlayersLastRiddenHorse'''(Actor ''horse'')]]
:'''Float [[GetExperienceForLevel - Game|GetExperienceForLevel]](Int ''currentLevel'')'''
|Sets the players last ridden horse, None will clear the last ridden horse.
:*Calculates the experience required for the player to level-up at the specified level
|-


|[[GetSkillLegendaryLevel - Game|Int '''GetSkillLegendaryLevel'''(String ''actorValue'')]]
:'''Bool [[GetPlayerMovementMode - Game|GetPlayerMovementMode]]()'''
|Returns the legendary level for the skill.
:*Returns true if in run mode, false if in walk mode. (This is only an indication of the control mode not if the player is actually running or walking.)
|-


|[[SetSkillLegendaryLevel - Game|'''SetSkillLegendaryLevel'''(String ''actorValue'', Int ''level'')]]
:'''[[UpdateThirdPerson - Game|UpdateThirdPerson]]()'''
|Sets the legendary level for the skill.
:*Updates the camera when changing shoulder positions.
|-


|[[GetPlayerMovementMode - Game|Bool '''GetPlayerMovementMode'''()]]
:'''[[UnbindObjectHotkey - Game|UnbindObjectHotkey]](Int ''hotkey'')'''
|Returns true if in run mode, false if in walk mode. (This is only an indication of the control mode not if the player is actually running or walking.)
:*Unbinds a favorited item bound to the specified hotkey. (0-7 reflects keys 1-8)
|-


|[[UpdateThirdPerson - Game|'''UpdateThirdPerson'''()]]
:'''Form [[GetHotkeyBoundObject - Game|GetHotkeyBoundObject]](Int ''hotkey'')'''
|Updates the camera when changing shoulder positions.
:*Returns the base form object that is bound to the specified hotkey.
|-


|[[UnbindObjectHotkey - Game|'''UnbindObjectHotkey'''(Int ''hotkey'')]]
:'''Bool [[IsObjectFavorited - Game|IsObjectFavorited]](Form ''form'')'''
|Unbinds a favorited item bound to the specified hotkey. (0-7 reflects keys 1-8)
:*Returns whether the specified base form is favorited by the player.
|-


|[[GetHotkeyBoundObject - Game|Form '''GetHotkeyBoundObject'''(Int ''hotkey'')]]
:'''Form [[GetFormEx - Game|GetFormEx]](Int ''formId'')'''
|Returns the base form object that is bound to the specified hotkey.
:*Performs the same function as [[GetForm - Game|GetForm]] but also works for form IDs greater than 0x80000000.
|-


|[[IsObjectFavorited - Game|Bool '''IsObjectFavorited'''(Form ''form'')]]
:'''[[SetPlayerLevel]](Int ''Level'')'''
|Returns whether the specified base form is favorited by the player.
:*Sets the player's level.
|-


|}
:'''ObjectReference [[GetCurrentCrosshairRef]]()'''
:*Returns the current crosshair ref.


:'''ObjectReference [[GetCurrentConsoleRef]]()'''
:*Returns the currently selected ref in the console.
[[Category:Scripting]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Papyrus]]
Anonymous user
Retrieved from "https://ck.uesp.net/wiki/Special:MobileDiff/10336...10346"

Navigation menu