Table of Contents

Class GameScript

Namespace
SkyrimForge.Papyrus
Assembly
SkyrimForge.Game.dll

Functions and comments from Game.psc.

public static class GameScript
Inheritance
GameScript
Inherited Members

Properties

Dispatcher

The dispatcher that binds this script to a form and calls the functions and properties that have no generated member.

public static PapyrusScriptDispatcher Dispatcher { get; }

Property Value

PapyrusScriptDispatcher

Methods

AddAchievement(int)

Adds the specified achievement to the player's profile

public static Task AddAchievement(int aiAchievementID)

Parameters

aiAchievementID int

Returns

Task

AddHavokBallAndSocketConstraint(IObjectReference, string, IObjectReference, string, float, float, float, float, float, float)

Adds a ball-and-socket constraint between two rigid bodies, identified by their ref and node names

public static Task<bool> AddHavokBallAndSocketConstraint(IObjectReference arRefA, string arRefANode, IObjectReference arRefB, string arRefBNode, float afRefALocalOffsetX = 0, float afRefALocalOffsetY = 0, float afRefALocalOffsetZ = 0, float afRefBLocalOffsetX = 0, float afRefBLocalOffsetY = 0, float afRefBLocalOffsetZ = 0)

Parameters

arRefA IObjectReference
arRefANode string
arRefB IObjectReference
arRefBNode string
afRefALocalOffsetX float
afRefALocalOffsetY float
afRefALocalOffsetZ float
afRefBLocalOffsetX float
afRefBLocalOffsetY float
afRefBLocalOffsetZ float

Returns

Task<bool>

AddPerkPoints(int)

Add the specified number of perk points to the player

public static Task AddPerkPoints(int aiPerkPoints)

Parameters

aiPerkPoints int

Returns

Task

AdvanceSkill(string, float)

Advance the given skill on the player by the provided amount of skill usage

public static Task AdvanceSkill(string asSkillName, float afMagnitude)

Parameters

asSkillName string
afMagnitude float

Returns

Task

CalculateFavorCost(int)

Calculates how much a x point favor would cost the player

public static Task<int> CalculateFavorCost(int aiFavorPrice)

Parameters

aiFavorPrice int

Returns

Task<int>

ClearPrison()

Clears the prison variables on the player

public static Task ClearPrison()

Returns

Task

ClearTempEffects()

Clears temp effects from game

public static Task ClearTempEffects()

Returns

Task

DisablePlayerControls(bool, bool, bool, bool, bool, bool, bool, bool, int)

Disables the user's controls

public static Task DisablePlayerControls(bool abMovement = true, bool abFighting = true, bool abCamSwitch = false, bool abLooking = false, bool abSneaking = false, bool abMenu = true, bool abActivate = true, bool abJournalTabs = false, int aiDisablePOVType = 0)

Parameters

abMovement bool
abFighting bool
abCamSwitch bool
abLooking bool
abSneaking bool
abMenu bool
abActivate bool
abJournalTabs bool
aiDisablePOVType int

Returns

Task

EnableFastTravel(bool)

Enables or disables the ability to fast travel

public static Task EnableFastTravel(bool abEnable = true)

Parameters

abEnable bool

Returns

Task

EnablePlayerControls(bool, bool, bool, bool, bool, bool, bool, bool, int)

Enables the user's controls

public static Task EnablePlayerControls(bool abMovement = true, bool abFighting = true, bool abCamSwitch = true, bool abLooking = true, bool abSneaking = true, bool abMenu = true, bool abActivate = true, bool abJournalTabs = true, int aiDisablePOVType = 0)

Parameters

abMovement bool
abFighting bool
abCamSwitch bool
abLooking bool
abSneaking bool
abMenu bool
abActivate bool
abJournalTabs bool
aiDisablePOVType int

Returns

Task

FadeOutGame(bool, bool, float, float)

Fades out the game to black, or vice versa

public static Task FadeOutGame(bool abFadingOut, bool abBlackFade, float afSecsBeforeFade, float afFadeDuration)

Parameters

abFadingOut bool
abBlackFade bool
afSecsBeforeFade float
afFadeDuration float

Returns

Task

FastTravel(IObjectReference)

Fast-travels the player to the specified object's location

public static Task FastTravel(IObjectReference akDestination)

Parameters

akDestination IObjectReference

Returns

Task

FindClosestActor(float, float, float, float)

Finds the closest actor within a given radius of a location

public static Task<Actor?> FindClosestActor(float afX, float afY, float afZ, float afRadius)

Parameters

afX float
afY float
afZ float
afRadius float

Returns

Task<Actor?>

FindClosestActorFromRef(IObjectReference, float)

Finds the closest actor within a given radius of a reference

public static Task<Actor?> FindClosestActorFromRef(IObjectReference arCenter, float afRadius)

Parameters

arCenter IObjectReference
afRadius float

Returns

Task<Actor?>

FindClosestReferenceOfAnyTypeInList(FormList, float, float, float, float)

Finds the closest reference of any base object in the list within a given radius of a location

public static Task<ObjectReference?> FindClosestReferenceOfAnyTypeInList(FormList arBaseObjects, float afX, float afY, float afZ, float afRadius)

Parameters

arBaseObjects FormList
afX float
afY float
afZ float
afRadius float

Returns

Task<ObjectReference?>

FindClosestReferenceOfAnyTypeInListFromRef(FormList, IObjectReference, float)

Finds the closest reference of a given base object within a given radius of a reference

public static Task<ObjectReference?> FindClosestReferenceOfAnyTypeInListFromRef(FormList arBaseObjects, IObjectReference arCenter, float afRadius)

Parameters

arBaseObjects FormList
arCenter IObjectReference
afRadius float

Returns

Task<ObjectReference?>

FindClosestReferenceOfType(IForm, float, float, float, float)

Finds the closest reference of a given base object within a given radius of a location

public static Task<ObjectReference?> FindClosestReferenceOfType(IForm arBaseObject, float afX, float afY, float afZ, float afRadius)

Parameters

arBaseObject IForm
afX float
afY float
afZ float
afRadius float

Returns

Task<ObjectReference?>

FindClosestReferenceOfTypeFromRef(IForm, IObjectReference, float)

Finds the closest reference of a given base object within a given radius of a reference

public static Task<ObjectReference?> FindClosestReferenceOfTypeFromRef(IForm arBaseObject, IObjectReference arCenter, float afRadius)

Parameters

arBaseObject IForm
arCenter IObjectReference
afRadius float

Returns

Task<ObjectReference?>

FindRandomActor(float, float, float, float)

Finds a random actor within a given radius of a location

public static Task<Actor?> FindRandomActor(float afX, float afY, float afZ, float afRadius)

Parameters

afX float
afY float
afZ float
afRadius float

Returns

Task<Actor?>

FindRandomActorFromRef(IObjectReference, float)

Finds a random actor within a given radius of a reference

public static Task<Actor?> FindRandomActorFromRef(IObjectReference arCenter, float afRadius)

Parameters

arCenter IObjectReference
afRadius float

Returns

Task<Actor?>

FindRandomReferenceOfAnyTypeInList(FormList, float, float, float, float)

Finds a random reference of a any base object in the list within a given radius of a location

public static Task<ObjectReference?> FindRandomReferenceOfAnyTypeInList(FormList arBaseObjects, float afX, float afY, float afZ, float afRadius)

Parameters

arBaseObjects FormList
afX float
afY float
afZ float
afRadius float

Returns

Task<ObjectReference?>

FindRandomReferenceOfAnyTypeInListFromRef(FormList, IObjectReference, float)

Finds a random reference of a given base object within a given radius of a reference

public static Task<ObjectReference?> FindRandomReferenceOfAnyTypeInListFromRef(FormList arBaseObjects, IObjectReference arCenter, float afRadius)

Parameters

arBaseObjects FormList
arCenter IObjectReference
afRadius float

Returns

Task<ObjectReference?>

FindRandomReferenceOfType(IForm, float, float, float, float)

Finds a random reference of a given base object within a given radius of a location

public static Task<ObjectReference?> FindRandomReferenceOfType(IForm arBaseObject, float afX, float afY, float afZ, float afRadius)

Parameters

arBaseObject IForm
afX float
afY float
afZ float
afRadius float

Returns

Task<ObjectReference?>

FindRandomReferenceOfTypeFromRef(IForm, IObjectReference, float)

Finds a random reference of a given base object within a given radius of a reference

public static Task<ObjectReference?> FindRandomReferenceOfTypeFromRef(IForm arBaseObject, IObjectReference arCenter, float afRadius)

Parameters

arBaseObject IForm
arCenter IObjectReference
afRadius float

Returns

Task<ObjectReference?>

ForceFirstPerson()

Make the player got to 1st person camera mode

public static Task ForceFirstPerson()

Returns

Task

ForceThirdPerson()

Make the player got to 3rd person camera mode

public static Task ForceThirdPerson()

Returns

Task

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

public static Task<int> GetCameraState()

Returns

Task<int>

GetCurrentConsoleRef()

Returns the currently selected ref in the console

public static Task<ObjectReference?> GetCurrentConsoleRef()

Returns

Task<ObjectReference?>

GetCurrentCrosshairRef()

Returns the current crosshair ref

public static Task<ObjectReference?> GetCurrentCrosshairRef()

Returns

Task<ObjectReference?>

GetDialogueTarget()

Returns the object reference the player is in dialogue with

public static Task<ObjectReference?> GetDialogueTarget()

Returns

Task<ObjectReference?>

GetExperienceForLevel(int)

Calculates the experience required for to level-up (fXPLevelUpBase + currentLevel * fXPLevelUpMult)

public static Task<float> GetExperienceForLevel(int currentLevel)

Parameters

currentLevel int

Returns

Task<float>

GetForm(int)

Returns the form specified by the ID

public static Task<Form?> GetForm(int aiFormID)

Parameters

aiFormID int

Returns

Task<Form?>

GetFormEx(int)

Same as GetForm, but also works for formIds >= 0x80000000

public static Task<Form?> GetFormEx(int formId)

Parameters

formId int

Returns

Task<Form?>

GetFormFromFile(int, string)

Returns the form specified by the ID originating in the given file

public static Task<Form?> GetFormFromFile(int aiFormID, string asFilename)

Parameters

aiFormID int
asFilename string

Returns

Task<Form?>

GetGameSettingFloat(string) 

public static Task<float> GetGameSettingFloat(string asGameSetting)

Parameters

asGameSetting string

Returns

Task<float>

GetGameSettingInt(string) 

public static Task<int> GetGameSettingInt(string asGameSetting)

Parameters

asGameSetting string

Returns

Task<int>

GetGameSettingString(string) 

public static Task<string> GetGameSettingString(string asGameSetting)

Parameters

asGameSetting string

Returns

Task<string>

GetHotkeyBoundObject(int)

Returns the base form object that is bound to the specified hotkey

public static Task<Form?> GetHotkeyBoundObject(int hotkey)

Parameters

hotkey int

Returns

Task<Form?>

GetLightModAuthor(int) 

public static Task<string> GetLightModAuthor(int idx)

Parameters

idx int

Returns

Task<string>

GetLightModByName(string) 

public static Task<int> GetLightModByName(string name)

Parameters

name string

Returns

Task<int>

GetLightModCount() 

public static Task<int> GetLightModCount()

Returns

Task<int>

GetLightModDependencyCount(int) 

public static Task<int> GetLightModDependencyCount(int idx)

Parameters

idx int

Returns

Task<int>

GetLightModDescription(int) 

public static Task<string> GetLightModDescription(int idx)

Parameters

idx int

Returns

Task<string>

GetLightModName(int) 

public static Task<string> GetLightModName(int idx)

Parameters

idx int

Returns

Task<string>

GetModAuthor(int)

returns the author of the mod at the specified modIndex

public static Task<string> GetModAuthor(int modIndex)

Parameters

modIndex int

Returns

Task<string>

GetModByName(string)

returns the index of the specified mod

public static Task<int> GetModByName(string name)

Parameters

name string

Returns

Task<int>

GetModCount()

returns the number of active mods

public static Task<int> GetModCount()

Returns

Task<int>

GetModDependencyCount(int)

gets the count of mods the specified mod depends upon

public static Task<int> GetModDependencyCount(int modIndex)

Parameters

modIndex int

Returns

Task<int>

GetModDescription(int)

returns the description of the mod at the specified modIndex

public static Task<string> GetModDescription(int modIndex)

Parameters

modIndex int

Returns

Task<string>

GetModName(int)

returns the name of the mod at the specified modIndex

public static Task<string> GetModName(int modIndex)

Parameters

modIndex int

Returns

Task<string>

GetNthLightModDependency(int, int) 

public static Task<int> GetNthLightModDependency(int modIdx, int idx)

Parameters

modIdx int
idx int

Returns

Task<int>

GetNthTintMaskColor(int)

Returns the color of the Nth tint mask

public static Task<int> GetNthTintMaskColor(int n)

Parameters

n int

Returns

Task<int>

GetNthTintMaskTexturePath(int)

Returns the texture path of the Nth tint mask

public static Task<string> GetNthTintMaskTexturePath(int n)

Parameters

n int

Returns

Task<string>

GetNthTintMaskType(int)

Returns the type of the Nth tint mask

public static Task<int> GetNthTintMaskType(int n)

Parameters

n int

Returns

Task<int>

GetNumTintMasks()

Returns the total number of tints for the player

public static Task<int> GetNumTintMasks()

Returns

Task<int>

GetNumTintsByType(int)

Returns how many indexes there are for this type

[Obsolete("Uses the Papyrus virtual machine. Prefer PlayerCharacter.GetNumTints(uint).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<int> GetNumTintsByType(int type)

Parameters

type int

Returns

Task<int>

GetPerkPoints() 

public static Task<int> GetPerkPoints()

Returns

Task<int>

GetPlayer()

Returns the player actor

public static Task<Actor?> GetPlayer()

Returns

Task<Actor?>

GetPlayerExperience()

Returns the players experience for this level (not total experience)

public static Task<float> GetPlayerExperience()

Returns

Task<float>

GetPlayerGrabbedRef()

Returns the reference the player is currently grabbing

public static Task<ObjectReference?> GetPlayerGrabbedRef()

Returns

Task<ObjectReference?>

GetPlayerMovementMode()

Returns true if in run mode, false if in walk mode Does not reflect actual movement state, only the control mode

public static Task<bool> GetPlayerMovementMode()

Returns

Task<bool>

GetPlayersLastRiddenHorse()

Returns the horse last ridden by the player

public static Task<Actor?> GetPlayersLastRiddenHorse()

Returns

Task<Actor?>

GetRealHoursPassed()

Returns the number of days spent in play

public static Task<float> GetRealHoursPassed()

Returns

Task<float>

GetSkillLegendaryLevel(string)

Returns the legendary level for the skill -1 indicates the particular skill cannot have a legendary level DEPRECATED

[Obsolete("Game.psc deprecates GetSkillLegendaryLevel.", DiagnosticId = "SKYRIMFORGE0003")]
public static Task<int> GetSkillLegendaryLevel(string actorValue)

Parameters

actorValue string

Returns

Task<int>

GetSunPositionX()

Returns the X position of the Sun.

public static Task<float> GetSunPositionX()

Returns

Task<float>

GetSunPositionY()

Returns the Y position of the Sun.

public static Task<float> GetSunPositionY()

Returns

Task<float>

GetSunPositionZ()

Returns the Z position of the Sun.

public static Task<float> GetSunPositionZ()

Returns

Task<float>

GetTintMaskColor(int, int)

Returns the color for the particular tintMask type and index

public static Task<int> GetTintMaskColor(int type, int index)

Parameters

type int
index int

Returns

Task<int>

GetTintMaskTexturePath(int, int)

Returns the texture path for the particular tintMask type and index

public static Task<string> GetTintMaskTexturePath(int type, int index)

Parameters

type int
index int

Returns

Task<string>

HideTitleSequenceMenu() 

public static Task HideTitleSequenceMenu()

Returns

Task

IncrementSkill(string)

Increment the given skill on the player by the one point

public static Task IncrementSkill(string asSkillName)

Parameters

asSkillName string

Returns

Task

IncrementSkillBy(string, int)

Increment the given skill on the player by the given number of points

public static Task IncrementSkillBy(string asSkillName, int aiCount)

Parameters

asSkillName string
aiCount int

Returns

Task

IncrementStat(string, int)

Modifies the specified MiscStat by the given amount.

public static Task IncrementStat(string asStatName, int aiModAmount = 1)

Parameters

asStatName string
aiModAmount int

Returns

Task

IsActivateControlsEnabled()

Are the activation controls enabled?

public static Task<bool> IsActivateControlsEnabled()

Returns

Task<bool>

IsCamSwitchControlsEnabled()

Are the camera switch controls enabled?

public static Task<bool> IsCamSwitchControlsEnabled()

Returns

Task<bool>

IsFastTravelControlsEnabled()

Is fast travel controls enabled? Returns false if EnableFastTravel(false) has been called

public static Task<bool> IsFastTravelControlsEnabled()

Returns

Task<bool>

IsFastTravelEnabled()

Is fast travel enabled?

public static Task<bool> IsFastTravelEnabled()

Returns

Task<bool>

IsFightingControlsEnabled()

Are the fighting controls enabled?

public static Task<bool> IsFightingControlsEnabled()

Returns

Task<bool>

IsJournalControlsEnabled()

Are the journal menu controls enabled?

public static Task<bool> IsJournalControlsEnabled()

Returns

Task<bool>

IsLookingControlsEnabled()

Are the looking controls enabled?

public static Task<bool> IsLookingControlsEnabled()

Returns

Task<bool>

IsMenuControlsEnabled()

Are the menu controls enabled?

public static Task<bool> IsMenuControlsEnabled()

Returns

Task<bool>

IsMovementControlsEnabled()

Are the movement controls enabled?

public static Task<bool> IsMovementControlsEnabled()

Returns

Task<bool>

IsObjectFavorited(IForm)

Returns if base form is favorited by the player

public static Task<bool> IsObjectFavorited(IForm form)

Parameters

form IForm

Returns

Task<bool>

IsPlayerSungazing()

Is the player looking at the sun?

public static Task<bool> IsPlayerSungazing()

Returns

Task<bool>

IsPluginInstalled(string) 

public static Task<bool> IsPluginInstalled(string name)

Parameters

name string

Returns

Task<bool>

IsSneakingControlsEnabled()

Are the sneaking controls enabled?

public static Task<bool> IsSneakingControlsEnabled()

Returns

Task<bool>

IsWordUnlocked(WordOfPower)

Is the specified Word of Power Unlocked?

public static Task<bool> IsWordUnlocked(WordOfPower akWord)

Parameters

akWord WordOfPower

Returns

Task<bool>

LoadGame(string) 

public static Task LoadGame(string name)

Parameters

name string

Returns

Task

ModPerkPoints(int) 

public static Task ModPerkPoints(int perkPoints)

Parameters

perkPoints int

Returns

Task

PlayBink(string, bool, bool, bool, bool)

Plays a bink video - does not return until bink has finished, use with care!

public static Task PlayBink(string asFileName, bool abInterruptible = false, bool abMuteAudio = true, bool abMuteMusic = true, bool abLetterbox = true)

Parameters

asFileName string
abInterruptible bool
abMuteAudio bool
abMuteMusic bool
abLetterbox bool

Returns

Task

PrecacheCharGen()

Precaches character gen data.

public static Task PrecacheCharGen()

Returns

Task

PrecacheCharGenClear()

Clears Precached character gen data.

public static Task PrecacheCharGenClear()

Returns

Task

QueryStat(string)

Queries the given stat and returns its value

public static Task<int> QueryStat(string asStat)

Parameters

asStat string

Returns

Task<int>

QuitToMainMenu()

Forces the game back to the main menu

public static Task QuitToMainMenu()

Returns

Task

RemoveHavokConstraints(IObjectReference, string, IObjectReference, string)

Removes any constraint between two rigid bodies

public static Task<bool> RemoveHavokConstraints(IObjectReference arFirstRef, string arFirstRefNodeName, IObjectReference arSecondRef, string arSecondRefNodeName)

Parameters

arFirstRef IObjectReference
arFirstRefNodeName string
arSecondRef IObjectReference
arSecondRefNodeName string

Returns

Task<bool>

RequestAutoSave()

Request that an auto-save be made

public static Task RequestAutoSave()

Returns

Task

RequestModel(string)

Requests the specified model

public static Task RequestModel(string asModelName)

Parameters

asModelName string

Returns

Task

RequestSave()

Request that a normal save be made

public static Task RequestSave()

Returns

Task

SaveGame(string) 

public static Task SaveGame(string name)

Parameters

name string

Returns

Task

SendWereWolfTransformation()

Finds an actor in high who can detect the player to call werewolf crime on the player

public static Task SendWereWolfTransformation()

Returns

Task

ServeTime()

Has the player serve their prison time

public static Task ServeTime()

Returns

Task

SetAllowFlyingMountLandingRequests(bool)

Allow or disallow player requests to have a flying mount land.

public static Task SetAllowFlyingMountLandingRequests(bool abAllow)

Parameters

abAllow bool

Returns

Task

SetBeastForm(bool)

Called as we enter/exit beast form

public static Task SetBeastForm(bool abEntering)

Parameters

abEntering bool

Returns

Task

SetCameraTarget(IActor)

Sets the camera target actor

public static Task SetCameraTarget(IActor arTarget)

Parameters

arTarget IActor

Returns

Task

SetGameSettingBool(string, bool) 

public static Task SetGameSettingBool(string setting, bool value)

Parameters

setting string
value bool

Returns

Task

SetGameSettingFloat(string, float) 

public static Task SetGameSettingFloat(string setting, float value)

Parameters

setting string
value float

Returns

Task

SetGameSettingInt(string, int) 

public static Task SetGameSettingInt(string setting, int value)

Parameters

setting string
value int

Returns

Task

SetGameSettingString(string, string) 

public static Task SetGameSettingString(string setting, string value)

Parameters

setting string
value string

Returns

Task

SetHudCartMode(bool)

Sets or clears "cart mode" for the HUD

public static Task SetHudCartMode(bool abSetCartMode = true)

Parameters

abSetCartMode bool

Returns

Task

SetInChargen(bool, bool, bool)

Informs the game whether we are in CharGen or not

public static Task SetInChargen(bool abDisableSaving, bool abDisableWaiting, bool abShowControlsDisabledMessage)

Parameters

abDisableSaving bool
abDisableWaiting bool
abShowControlsDisabledMessage bool

Returns

Task

SetMiscStat(string, int)

set a misc stat value use QueryStat to read the value

public static Task SetMiscStat(string name, int value)

Parameters

name string
value int

Returns

Task

SetNthTintMaskColor(int, int)

Sets the color of the Nth tint mask

public static Task SetNthTintMaskColor(int n, int color)

Parameters

n int
color int

Returns

Task

SetNthTintMaskTexturePath(string, int)

Sets the texturepath of the Nth tint mask

public static Task SetNthTintMaskTexturePath(string path, int n)

Parameters

path string
n int

Returns

Task

SetPerkPoints(int) 

public static Task SetPerkPoints(int perkPoints)

Parameters

perkPoints int

Returns

Task

SetPlayerAIDriven(bool)

Enables or disables the AI driven flag on Player

[Obsolete("Uses the Papyrus virtual machine. Prefer PlayerCharacter.SetAIDriven(bool).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task SetPlayerAIDriven(bool abAIDriven = true)

Parameters

abAIDriven bool

Returns

Task

SetPlayerExperience(float)

Sets the players experience, does not trigger level-up notification

public static Task SetPlayerExperience(float exp)

Parameters

exp float

Returns

Task

SetPlayerLevel(int)

Sets the player level

public static Task SetPlayerLevel(int level)

Parameters

level int

Returns

Task

SetPlayerReportCrime(bool)

Enables or disables crime reporting on Player

public static Task SetPlayerReportCrime(bool abReportCrime = true)

Parameters

abReportCrime bool

Returns

Task

SetPlayersLastRiddenHorse(IActor)

Sets the players last ridden horse, None will clear the lastRiddenHorse

public static Task SetPlayersLastRiddenHorse(IActor horse)

Parameters

horse IActor

Returns

Task

SetSittingRotation(float)

Set the players sitting camera rotation - in degrees, offset from the standard angle.

public static Task SetSittingRotation(float afValue)

Parameters

afValue float

Returns

Task

SetSkillLegendaryLevel(string, int)

Sets the legendary level for the skill DEPRECATED

[Obsolete("Game.psc deprecates SetSkillLegendaryLevel.", DiagnosticId = "SKYRIMFORGE0003")]
public static Task SetSkillLegendaryLevel(string actorValue, int level)

Parameters

actorValue string
level int

Returns

Task

SetSunGazeImageSpaceModifier(ImageSpaceModifier?)

Sets the Image Space Modifier that is triggered when the player gazes at the sun.

public static Task SetSunGazeImageSpaceModifier(ImageSpaceModifier? apImod = null)

Parameters

apImod ImageSpaceModifier?

Returns

Task

SetTintMaskColor(int, int, int)

Sets the tintMask color for the particular type and index

public static Task SetTintMaskColor(int color, int type, int index)

Parameters

color int
type int
index int

Returns

Task

SetTintMaskTexturePath(string, int, int)

Sets the tintMask texture for the particular type and index

public static Task SetTintMaskTexturePath(string path, int type, int index)

Parameters

path string
type int
index int

Returns

Task

ShakeCamera(IObjectReference?, float, float)

Shakes the object from the location of the passed-in object. If none, it will shake the camera from the player's location. Strength is clamped from 0 to 1 Duration in seconds. By default (0.0) use the game setting.

[Obsolete("Uses the Papyrus virtual machine. Prefer GameTarget.ShakeCamera(IObjectReference, float, float).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task ShakeCamera(IObjectReference? akSource = null, float afStrength = 0.5, float afDuration = 0)

Parameters

akSource IObjectReference
afStrength float
afDuration float

Returns

Task

ShakeController(float, float, float)

Shakes the controller for the specified length of time (in seconds). The strength values are clamped from 0 to 1

public static Task ShakeController(float afSmallMotorStrength, float afBigMotorStreangth, float afDuration)

Parameters

afSmallMotorStrength float
afBigMotorStreangth float
afDuration float

Returns

Task

ShowFirstPersonGeometry(bool)

Show the players first person geometry.

public static Task ShowFirstPersonGeometry(bool abShow = true)

Parameters

abShow bool

Returns

Task

ShowLimitedRaceMenu() 

public static Task ShowLimitedRaceMenu()

Returns

Task

ShowRaceMenu() 

public static Task ShowRaceMenu()

Returns

Task

ShowTitleSequenceMenu() 

public static Task ShowTitleSequenceMenu()

Returns

Task

ShowTrainingMenu(IActor)

Displays the training menu based on passed in trainer actor

public static Task ShowTrainingMenu(IActor aTrainer)

Parameters

aTrainer IActor

Returns

Task

StartTitleSequence(string) 

public static Task StartTitleSequence(string asSequenceName)

Parameters

asSequenceName string

Returns

Task

TeachWord(WordOfPower)

Teaches the specified word of power to the player

public static Task TeachWord(WordOfPower akWord)

Parameters

akWord WordOfPower

Returns

Task

TriggerScreenBlood(int)

Trigger screen blood with the given count

public static Task TriggerScreenBlood(int aiValue)

Parameters

aiValue int

Returns

Task

UnbindObjectHotkey(int)

Hotkeys 0-7 reflect keys 1-8 Unbinds a favorited item bound to the specified hotkey

public static Task UnbindObjectHotkey(int hotkey)

Parameters

hotkey int

Returns

Task

UnlockWord(WordOfPower)

Unlocks the specified word of power so the player can use it

public static Task UnlockWord(WordOfPower akWord)

Parameters

akWord WordOfPower

Returns

Task

UpdateHairColor()

Updates the players hair color immediately

public static Task UpdateHairColor()

Returns

Task

UpdateThirdPerson()

Updates the camera when changing Shoulder positions

[Obsolete("Uses the Papyrus virtual machine. Prefer PlayerCamera.UpdateThirdPerson(bool).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task UpdateThirdPerson()

Returns

Task

UpdateTintMaskColors()

Updates tintMask colors without updating the entire model

public static Task UpdateTintMaskColors()

Returns

Task

UsingGamepad()

Returns true if we're using a gamepad

public static Task<bool> UsingGamepad()

Returns

Task<bool>