the CreationKit Wiki

Difference between revisions of "Game Script"

Game Script (edit)

Revision as of 02:28, 24 October 2013

2,099 bytes added ,  02:28, 24 October 2013
m
Fixed a mistake that lost half the page....whoops
imported>CraftySentinel
m
imported>CraftySentinel
m (Fixed a mistake that lost half the page....whoops)
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.
|-
 
|[[AdvanceSkill - Game|'''AdvanceSkill'''(String ''asSkillName'', Float ''afMagnitude'')]]
|Advance the given skill on the player by the provided amount of skill usage
|-


'''Function [[AdvanceSkill - Game|AdvanceSkill]](string asSkillName, float afMagnitude)'''
|[[AddHavokBallAndSocketConstraint - Game|Bool '''AddHavokBallAndSocketConstraint'''(ObjectReference ''arRefA'', String ''arRefANode'', ObjectReference ''arRefB'', String ''arRefBNode'', Float ''afRefALocalOffsetX'', Float ''afRefALocalOffsetY'', Float ''afRefALocalOffsetZ'', Float ''afRefBLocalOffsetX'', Float ''afRefBLocalOffsetY'', Float ''afRefBLocalOffsetZ'')]]
*Advance the given skill on the player by the provided amount of skill usage
|Adds a ball-and-socket constraint between two rigid bodies, identified by their ref and node names
|-


'''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)'''
|[[CalculateFavorCost - Game|Int '''CalculateFavorCost'''(Int ''aiFavorPrice'')]]
*Adds a ball-and-socket constraint between two rigid bodies, identified by their ref and node names
|Calculates how many points the player would have to pay for a favor of the specified price.
|-


'''int Function [[CalculateFavorCost - Game|CalculateFavorCost]](int aiFavorPrice)'''
|[[ClearPrison - Game|'''ClearPrison'''()]]
*Calculates how many points the player would have to pay for a favor of the specified price.
|Clears all Prison variables on the PlayerCharacter so the game will know he is out of prison.
|-


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


'''Function [[ClearTempEffects - Game|ClearTempEffects]]()'''
|[[DisablePlayerControls - Game|'''DisablePlayerControls'''(Bool ''abMovement'', Bool ''abFighting'', Bool ''abCamSwitch'', Bool ''abLooking'', Bool ''abSneaking'', Bool ''abMenu'', Bool ''abActivate'', Bool ''abJournalTabs'', Int ''aiDisablePOVType'')]]
*Clears all temp effects (such as terrain effects) in the game.
|Disables the specified player controls.
|-


'''Function [[DisablePlayerControls - Game|DisablePlayerControls]](bool abMovement, bool abFighting, bool abCamSwitch, bool abLooking, bool abSneaking, bool abMenu, bool abActivate, bool abJournalTabs, int aiDisablePOVType)'''
|[[EnableFastTravel - Game|'''EnableFastTravel'''(Bool ''abEnable'')]]
*Disables the specified player controls.
|Enables or disables the player's ability to fast travel.
|-


'''Function [[EnableFastTravel - Game|EnableFastTravel]](bool abEnable)'''
|[[EnablePlayerControls - Game|'''EnablePlayerControls'''(Bool ''abMovement'', Bool ''abFighting'', Bool ''abCamSwitch'', Bool ''abLooking'', Bool ''abSneaking'', Bool ''abMenu'', Bool ''abActivate'', Bool ''abJournalTabs'', Int ''aiDisablePOVType'')]]
*Enables or disables the player's ability to fast travel.
|Enables the specified player controls.
|-


'''Function [[EnablePlayerControls - Game|EnablePlayerControls]](bool abMovement, bool abFighting, bool abCamSwitch, bool abLooking, bool abSneaking, bool abMenu, bool abActivate, bool abJournalTabs, int aiDisablePOVType)'''
|[[FadeOutGame - Game|'''FadeOutGame'''(Bool ''abFadingOut'', Bool ''abBlackFade'', Float ''afSecsBeforeFade'', Float ''afFadeDuration'')]]
*Enables the specified player controls.
|Fades the game in and out with the specified parameters.
|-


'''Function [[FadeOutGame - Game|FadeOutGame]](bool abFadingOut, bool abBlackFade, float afSecsBeforeFade, float afFadeDuration)'''
|[[FastTravel - Game|'''FastTravel'''(ObjectReference ''akDestination'')]]
*Fades the game in and out with the specified parameters.
|Fast-travels the player to the specified object's location.
|-


'''Function [[FastTravel - Game|FastTravel]](ObjectReference akDestination)'''
|[[FindClosestActor - Game|Actor '''FindClosestActor'''(Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
*Fast-travels the player to the specified object's location.
|Finds the closest actor within a given radius of a location
|-


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


'''Actor Function [[FindClosestActorFromRef - Game|FindClosestActorFromRef]](ObjectReference arCenter, float afRadius)'''
|[[FindClosestReferenceOfAnyTypeInList - Game|ObjectReference '''FindClosestReferenceOfAnyTypeInList'''(FormList ''arBaseObjects'', Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
*Finds the closest actor 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 location
|-


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


'''ObjectReference Function [[FindClosestReferenceOfAnyTypeInListFromRef - Game|FindClosestReferenceOfAnyTypeInListFromRef]](FormList arBaseObjects, ObjectReference arCenter, float afRadius)'''
|[[FindClosestReferenceOfType - Game|ObjectReference '''FindClosestReferenceOfType'''(Form ''arBaseObject'', 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 reference
|Finds the closest reference of a given base object within a given radius of a location
|-


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


'''ObjectReference Function [[FindClosestReferenceOfTypeFromRef - Game|FindClosestReferenceOfTypeFromRef]](Form arBaseObject, ObjectReference arCenter, float afRadius)'''
|[[FindRandomActor - Game|Actor '''FindRandomActor'''(Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
*Finds the closest reference of a given base object within a given radius of a reference
|Finds a random actor within a given radius of a location
|-


'''Actor Function [[FindRandomActor - Game|FindRandomActor]](float afX, float afY, float afZ, float afRadius)'''
|[[FindRandomActorFromRef - Game|Actor '''FindRandomActorFromRef'''(ObjectReference ''arCenter'', Float ''afRadius'')]]
*Finds a random actor within a given radius of a location
|Finds a random actor within a given radius of a reference
|-


'''Actor Function [[FindRandomActorFromRef - Game|FindRandomActorFromRef]](ObjectReference arCenter, float afRadius)'''
|[[FindRandomReferenceOfAnyTypeInList - Game|ObjectReference '''FindRandomReferenceOfAnyTypeInList'''(FormList ''arBaseObjects'', Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afRadius'')]]
*Finds a random actor 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 location
|-


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


'''ObjectReference Function [[FindRandomReferenceOfAnyTypeInListFromRef - Game|FindRandomReferenceOfAnyTypeInListFromRef]](FormList arBaseObjects, ObjectReference arCenter, float afRadius)'''
|[[FindRandomReferenceOfType - Game|ObjectReference '''FindRandomReferenceOfType'''(Form ''arBaseObject'', 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 reference
|Finds a random reference of a given base object within a given radius of a location
|-


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


'''ObjectReference Function [[FindRandomReferenceOfTypeFromRef - Game|FindRandomReferenceOfTypeFromRef]](Form arBaseObject, ObjectReference arCenter, float afRadius)'''
|[[ForceFirstPerson - Game|'''ForceFirstPerson'''()]]
*Finds a random reference of a given base object within a given radius of a reference
|Forces the player camera into 1st-person.
|-


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


'''Function [[ForceThirdPerson - Game|ForceThirdPerson]]()'''
|[[GetForm - Game|Form '''GetForm'''(Int ''aiFormID'')]]
*Forces the player camera into 3rd-person.
|Obtains a [[Form Script|Form]] from the game by its form ID number.
|-


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


'''Form Function [[GetFormFromFile - Game|GetFormFromFile]](int aiFormID, string asFilename)'''
|[[GetGameSettingFloat - Game|Float '''GetGameSettingFloat'''(String ''asGameSetting'')]]
*Obtains the form specified by its form ID number which originated in the specified file.
|Obtains the value of a float game setting.
|-


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


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


'''float Function [[GetGameSettingString - Game|GetGameSettingString]](string asGameSetting)'''
|[[GetPlayer - Game|Actor '''GetPlayer'''()]]
*Obtains the value of a string game setting.
|Obtains the [[Actor Script|Actor]] that represents the player.
|-


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


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


'''Actor Function [[GetPlayersLastRiddenHorse - Game|GetPlayersLastRiddenHorse]]()'''
|[[GetRealHoursPassed - Game|Float '''GetRealHoursPassed'''()]]
*Gets this actors last ridden horse if it is the player. Returns None if player has not ridden a horse is not the player.
|Returns the number of real-life hours that have passed playing the game.
|-


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


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


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


'''float Function [[GetSunPositionZ - Game|GetSunPositionZ]]()'''
|[[HideTitleSequenceMenu - Game|'''HideTitleSequenceMenu'''()]]
*Gets the Z position of the sun.
|Hides the title sequence menu.
|-


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


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


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


'''Function [[IncrementStat - Game|IncrementStat]](string asStatName, int aiModAmount) native global'''
|[[IsActivateControlsEnabled - Game|Bool '''IsActivateControlsEnabled'''()]]
*Modifies the specified MiscStat by the given amount
|Are the activation controls enabled?
|-


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


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


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


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


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


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


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


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


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


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


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


'''bool Function [[IsWordUnlocked - Game|IsWordUnlocked]](WordOfPower akWord)'''
|[[PlayBink - Game|'''PlayBink'''(String ''asFileName'', Bool ''abInterruptible'', Bool ''abMuteAudio'', Bool ''abMuteMusic'', Bool ''abLetterbox'')]]
*Is the word of power unlocked on the player?
|Plays a bink video
|-


'''Function [[PlayBink - Game|PlayBink]](string asFileName, bool abInterruptible, bool abMuteAudio, bool abMuteMusic, bool abLetterbox)'''
|[[PrecacheCharGen - Game|'''PrecacheCharGen'''()]]
*Plays a bink video
|Precaches all the data used by character gen to avoid hitches with file I/O.
|-


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


'''Function [[PrecacheCharGenClear - Game|PrecacheCharGenClear]]()'''
|[[QueryStat - Game|Int '''QueryStat'''(String ''asStat'')]]
*Clears all the previously cached data used by character gen.
|Queries the given stat and returns its value.
|-


'''int Function [[QueryStat - Game|QueryStat]](string asStat)'''
|[[QuitToMainMenu - Game|'''QuitToMainMenu'''()]]
*Queries the given stat and returns its value.
|Forces the game back to the main menu.
|-


'''Function [[QuitToMainMenu - Game|QuitToMainMenu]]()'''
|[[RemoveHavokConstraints - Game|Bool '''RemoveHavokConstraints'''(ObjectReference ''arFirstRef'', String ''arFirstRefNodeName'', ObjectReference ''arSecondRef'', String ''arSecondRefNodeName'')]]
*Forces the game back to the main menu.
|Removes any constraint between two rigid bodies
|-


'''bool Function [[RemoveHavokConstraints - Game|RemoveHavokConstraints]](ObjectReference arFirstRef, string arFirstRefNodeName, ObjectReference arSecondRef, string arSecondRefNodeName)'''
|[[RequestAutoSave - Game|'''RequestAutoSave'''()]]
*Removes any constraint between two rigid bodies
|Requests for an auto-save to be made.
|-


'''Function [[RequestAutoSave - Game|RequestAutoSave]]()'''
|[[RequestModel - Game|'''RequestModel'''(String ''asModelName'')]]
*Requests for an auto-save to be made.
|Requests the specified model.
|-


'''Function [[RequestModel - Game|RequestModel]](string asModelName)'''
|[[RequestSave - Game|'''RequestSave'''()]]
*Requests the specified model.
|Requests for a normal save to be made.
|-


'''Function [[RequestSave - Game|RequestSave]]()'''
|[[SendWereWolfTransformation - Game|'''SendWereWolfTransformation'''()]]
*Requests for a normal save to be made.
|Finds an actor in high who can detect the player to call werewolf crime on the player
|-


'''Function [[SendWereWolfTransformation - Game|SendWereWolfTransformation]]()'''
|[[ServeTime - Game|'''ServeTime'''()]]
*Finds an actor in high who can detect the player to call werewolf crime on the player
|Has the player serve their jail time.
|-


'''Function [[ServeTime - Game|ServeTime]]()'''
|[[SetAllowFlyingMountLandingRequests - Game|'''SetAllowFlyingMountLandingRequests'''(Bool ''abAllow'')]]
*Has the player serve their jail time.
|Allow or disallow the player requests to have a flying mount land.
|-


'''Function [[SetAllowFlyingMountLandingRequests - Game|SetAllowFlyingMountLandingRequests]](bool abAllow)'''
|[[SetBeastForm - Game|'''SetBeastForm'''(Bool ''abEntering'')]]
*Allow or disallow the player requests to have a flying mount land.
|Flags the player as being in/out of "beast form".
|-


'''Function [[SetBeastForm - Game|SetBeastForm]](bool abEntering)'''
|[[SetCameraTarget - Game|'''SetCameraTarget'''(Actor ''arTarget'')]]
*Flags the player as being in/out of "beast form".
|Sets the camera target actor
|-


'''Function [[SetCameraTarget - Game|SetCameraTarget]](Actor arTarget)'''
|[[SetHudCartMode - Game|'''SetHudCartMode'''(Bool ''abSetCartMode'')]]
*Sets the camera target actor
|Flags the HUD as being in "cart mode" or not.
|-


'''Function [[SetHudCartMode - Game|SetHudCartMode]](bool abSetCartMode)'''
|[[SetInChargen - Game|'''SetInChargen'''(Bool ''abDisableSaving'', Bool ''abDisableWaiting'', Bool ''abShowControlsDisabledMessage'')]]
*Flags the HUD as being in "cart mode" or not.
|Enable/disable various functionality which we want in chargen.
|-


'''Function [[SetInChargen - Game|SetInChargen]](bool abDisableSaving, bool abDisableWaiting, bool abShowControlsDisabledMessage)'''
|[[SetPlayerAIDriven - Game|'''SetPlayerAIDriven'''(Bool ''abAIDriven'')]]
*Enable/disable various functionality which we want in chargen.
|Enables or disables the AI driven flag on the player.
|-


'''Function [[SetPlayerAIDriven - Game|SetPlayerAIDriven]](bool abAIDriven)'''
|[[SetPlayerReportCrime - Game|'''SetPlayerReportCrime'''(Bool ''abReportCrime'')]]
*Enables or disables the AI driven flag on the player.
|Set the state of the player as an actor who commits crimes
|-


'''Function [[SetPlayerReportCrime - Game|SetPlayerReportCrime]](bool abReportCrime)'''
|[[SetSittingRotation - Game|'''SetSittingRotation'''(Float ''afValue'')]]
*Set the state of the player as an actor who commits crimes
|Set the player's sitting camera offset rotation.
|-


'''Function [[SetSittingRotation - Game|SetSittingRotation]](float afValue)'''
|[[SetSunGazeImageSpaceModifier - Game|'''SetSunGazeImageSpaceModifier'''(ImageSpaceModifier ''apImod'')]]
*Set the player's sitting camera offset rotation.
|Will cause the specified ImageSpace Modifier to be triggered when the player begins looking at the sun
|-


'''Function [[SetSunGazeImageSpaceModifier - Game|SetSunGazeImageSpaceModifier]](ImageSpaceModifier apImod)'''
|[[ShakeCamera - Game|'''ShakeCamera'''(ObjectReference ''akSource'', Float ''afStrength'')]]
*Will cause the specified ImageSpace Modifier to be triggered when the player begins looking at the sun
|Shakes the camera from the specified location with the specified strength.
|-


'''Function [[ShakeCamera - Game|ShakeCamera]](ObjectReference akSource, float afStrength)'''
|[[ShakeController - Game|'''ShakeController'''(Float ''afLeftStrength'', Float ''afRightStrength'', Float ''afDuration'')]]
*Shakes the camera from the specified location with the specified strength.
|Shakes the controller for the specified amount of time.
|-


'''Function [[ShakeController - Game|ShakeController]](float afLeftStrength, float afRightStrength, float afDuration)'''
|[[ShowFirstPersonGeometry - Game|'''ShowFirstPersonGeometry'''(Bool ''abShow'')]]
*Shakes the controller for the specified amount of time.
|Shows or hides the first-person geometry
|-


'''Function [[ShowFirstPersonGeometry - Game|ShowFirstPersonGeometry]](bool abShow)'''
|[[ShowLimitedRaceMenu - Game|'''ShowLimitedRaceMenu'''()]]
*Shows or hides the first-person geometry
|Shows the race/sex change menu, but without the ability to change race or sex.
|-


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


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


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


'''Function [[ShowTrainingMenu - Game|ShowTrainingMenu]](Actor aActor)'''
|[[StartTitleSequence - Game|'''StartTitleSequence'''(String ''asSequenceName'')]]
*Shows the training menu provided by actor parameter.
|Plays the specified sequence in the title menu.
|-


'''Function [[StartTitleSequence - Game|StartTitleSequence]](string asSequenceName)'''
|[[TeachWord - Game|'''TeachWord'''(WordOfPower ''akWord'')]]
*Plays the specified sequence in the title menu.
|Teaches the specified [[WordOfPower Script|WordOfPower]] to the player
|-


'''Function [[TeachWord - Game|TeachWord]](WordOfPower akWord)'''
|[[TriggerScreenBlood - Game|'''TriggerScreenBlood'''(Int ''aiValue'')]]
*Teaches the specified [[WordOfPower Script|WordOfPower]] to the player
|Trigger on-screen blood splatter.
|-


'''Function [[TriggerScreenBlood - Game|TriggerScreenBlood]](int aiValue)'''
|[[UnlockWord - Game|'''UnlockWord'''(WordOfPower ''akWord'')]]
*Trigger on-screen blood splatter.
|Unlocks the specified [[WordOfPower Script|WordOfPower]] so the player can use it
|-


'''Function [[UnlockWord - Game|UnlockWord]](WordOfPower akWord)'''
|[[UsingGamepad - Game|Bool '''UsingGamepad'''()]]
*Unlocks the specified [[WordOfPower Script|WordOfPower]] so the player can use it
|Returns whether the player is using a gamepad or not.
|-


'''bool Function [[UsingGamepad - Game|UsingGamepad]]()'''
|}
*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
|-
 
|[[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.
|-


'''Function [[ModPerkPoints - Game|ModPerkPoints]](int perkPoints)'''
|[[GetNumTintMasks - Game|Int '''GetNumTintMasks'''()]]
*Changes the number of perk points available to the player by the specified amount.
|Returns the total number of tints for the player.
|-


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


'''Function [[SetGameSettingInt - Game|SetGameSettingInt]](String setting, int value)'''
|[[GetNthTintMaskType - Game|Int '''GetNthTintMaskType'''(Int ''n'')]]
*Changes the value of integer Game Settings.
|Returns the type of the Nth tint mask.
|-


'''Function [[SetGameSettingFloat - Game|SetGameSettingFloat]](String setting, float value)'''
|[[SetNthTintMaskColor - Game|Int '''SetNthTintMaskColor'''(Int ''n'', Int ''color'')]]
*Changes the value of float Game Settings.
|Sets the color of the Nth tint mask.
|-


'''Function [[SetGameSettingString - Game|SetGameSettingString]](String setting, string value)'''
|[[GetNthTintMaskTexturePath - Game|String '''GetNthTintMaskTexturePath'''(Int ''n'')]]
*Changes the value of string Game Settings.
|Returns the texture path of the Nth tint mask.
|-


'''int Function [[GetModCount - Game|GetModCount]]()'''
|[[SetNthTintMaskTexturePath - Game|'''SetNthTintMaskTexturePath'''(Int ''n'')]]
*Returns the number of mods currently active.
|Sets the texturepath of the Nth tint mask.
|-


'''string Function [[GetModName - Game|GetModName]](int modIndex)'''
|[[GetNumTintsByType - Game|Int '''GetNumTintsByType'''(Int ''type'')]]
*Returns the mods name at the specified index.
|Returns how many indexes there are for this type.
|-


'''string Function [[GetModAuthor - Game|GetModAuthor]](int modIndex)'''
|[[GetTintMaskColor - Game|Int '''GetTintMaskColor'''(Int ''type'', Int ''index'')]]
*Returns the specified mod's author.
|Returns the color for the particular tintMask type and index.
|-


'''string Function [[GetModDescription - Game|GetModDescription]](int modIndex)'''
|[[SetTintMaskColor - Game|'''SetTintMaskColor'''(Int ''color'', Int ''type'', Int ''index'')]]
*Returns the specified mod's description.
|Sets the tintMask color for the particular type and index
|-


'''int Function [[GetModDependencyCount - Game|GetModDependencyCount]](int modIndex)'''
|[[UpdateHairColor - Game|'''UpdateHairColor'''()]]
*Returns the dependency count of the specified mod.
|Instantly updates the player's hair color.
|-


'''int Function [[GetNthModDependency - Game|GetNthModDependency]](int modIndex, int n)'''
|[[GetSkillLegendaryLevel - Game|Int '''GetSkillLegendaryLevel'''(String ''actorValue'')]]
*Returns the mod index of the specified Dependency.
|Returns the legendary level for the skill
|-


'''int Function [[GetCameraState - Game|GetCameraState]]()'''
|[[SetSkillLegendaryLevel - Game|'''SetSkillLegendaryLevel'''(String ''actorValue'', Int ''level'')]]
*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)
|Sets the legendary level for the skill.
|-


== Member Functions ==
|}
None


== Events ==
[[Category:Scripting]]
None
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]
Retrieved from "https://ck.uesp.net/wiki/Special:MobileDiff/10334"