Starfield Mod:Script-Game

From Starfield Wiki
Jump to: navigation, search


Game
Script Game
Extends ScriptObject



Definition[edit]

The Game.psc source file header definition for this script.

ScriptName Game Native Hidden


Documentation[edit]

The Game.psc source file documentation comments for this script.

No documentation provided.


Members[edit]

The members that belong to this script.


AddAchievement
Script Game
Name AddAchievement
Kind Function
Flags Native Global
Returns None
Parameters int aiAchievementID
Documentation Adds the specified achievement to the player's profile
Game Version v0.0.0+




AddToAvailableCrew
Script Game
Name AddToAvailableCrew
Kind Function
Flags Native Global
Returns bool
Parameters Actor akActor
Documentation Adds the specified actor to the player's unassigned crew list
Game Version v0.0.0+




AddPerkPoints
Script Game
Name AddPerkPoints
Kind Function
Flags Native Global
Returns None
Parameters int aiPerkPoints
Documentation Add the specified number of perk points to the player
Game Version v0.0.0+




AddPlayerOwnedShip
Script Game
Name AddPlayerOwnedShip
Kind Function
Flags Native Global
Returns None
Parameters SpaceshipReference arRef
Documentation Add the specified spaceship to the player's owned ships
Game Version v0.0.0+




AdvanceSkill
Script Game
Name AdvanceSkill
Kind Function
Flags Native Global
Returns None
Parameters string asSkillName, float afMagnitude
Documentation Advance the given skill on the player by the provided amount of skill usage
Game Version v0.0.0+




AreHostileActorsNear
Script Game
Name AreHostileActorsNear
Kind Function
Flags Native Global
Returns bool
Documentation Check if hostile actors are near
Game Version v0.0.0+




ClearPrison
Script Game
Name ClearPrison
Kind Function
Flags Native Global
Returns None
Documentation Clears the prison variables on the player
Game Version v0.0.0+




ClearTempEffects
Script Game
Name ClearTempEffects
Kind Function
Flags Native Global
Returns None
Documentation Clears temp effects from game
Game Version v0.0.0+




Error
Script Game
Name Error
Kind Function
Flags Native Global BetaOnly
Returns None
Parameters string asMessage
Documentation Issue an error with stack trace to the script log and warning system
Game Version v0.0.0+




FadeOutGame
Script Game
Name FadeOutGame
Kind Function
Flags Native Global
Returns None
Parameters bool abFadingOut, bool abBlackFade, float afSecsBeforeFade, float afFadeDuration, bool abStayFaded = false
Documentation Fades out the game to black, or vice versa
Game Version v0.0.0+




FastTravel
Script Game
Name FastTravel
Kind Function
Flags Native Global
Returns None
Parameters ObjectReference akDestination
Documentation Fast-travels the player to the specified object's location
Game Version v0.0.0+




FindClosestReferenceOfType
Script Game
Name FindClosestReferenceOfType
Kind Function
Flags Native Global
Returns ObjectReference
Parameters Form arBaseObject, float afX, float afY, float afZ, float afRadius
Documentation Finds the closest reference of a given base object within a given radius of a location
Game Version v0.0.0+




FindRandomReferenceOfType
Script Game
Name FindRandomReferenceOfType
Kind Function
Flags Native Global
Returns ObjectReference
Parameters Form arBaseObject, float afX, float afY, float afZ, float afRadius
Documentation Finds a random reference of a given base object within a given radius of a location
Game Version v0.0.0+




FindClosestReferenceOfAnyTypeInList
Script Game
Name FindClosestReferenceOfAnyTypeInList
Kind Function
Flags Native Global
Returns ObjectReference
Parameters FormList arBaseObjects, float afX, float afY, float afZ, float afRadius
Documentation Finds the closest reference of any base object in the list within a given radius of a location
Game Version v0.0.0+




FindRandomReferenceOfAnyTypeInList
Script Game
Name FindRandomReferenceOfAnyTypeInList
Kind Function
Flags Native Global
Returns ObjectReference
Parameters FormList arBaseObjects, float afX, float afY, float afZ, float afRadius
Documentation Finds a random reference of a any base object in the list within a given radius of a location
Game Version v0.0.0+




FindClosestReferenceOfTypeFromRef
Script Game
Name FindClosestReferenceOfTypeFromRef
Kind Function
Flags Global
Returns ObjectReference
Parameters Form arBaseObject, ObjectReference arCenter, float afRadius
Documentation Finds the closest reference of a given base object within a given radius of a reference
Game Version v0.0.0+




FindRandomReferenceOfTypeFromRef
Script Game
Name FindRandomReferenceOfTypeFromRef
Kind Function
Flags Global
Returns ObjectReference
Parameters Form arBaseObject, ObjectReference arCenter, float afRadius
Documentation Finds a random reference of a given base object within a given radius of a reference
Game Version v0.0.0+




FindClosestReferenceOfAnyTypeInListFromRef
Script Game
Name FindClosestReferenceOfAnyTypeInListFromRef
Kind Function
Flags Global
Returns ObjectReference
Parameters FormList arBaseObjects, ObjectReference arCenter, float afRadius
Documentation Finds the closest reference of a given base object within a given radius of a reference
Game Version v0.0.0+




FindRandomReferenceOfAnyTypeInListFromRef
Script Game
Name FindRandomReferenceOfAnyTypeInListFromRef
Kind Function
Flags Global
Returns ObjectReference
Parameters FormList arBaseObjects, ObjectReference arCenter, float afRadius
Documentation Finds a random reference of a given base object within a given radius of a reference
Game Version v0.0.0+




FindClosestActor
Script Game
Name FindClosestActor
Kind Function
Flags Native Global
Returns Actor
Parameters float afX, float afY, float afZ, float afRadius
Documentation Finds the closest actor within a given radius of a location (may return dead actors)
Game Version v0.0.0+




FindClosestLivingActor
Script Game
Name FindClosestLivingActor
Kind Function
Flags Native Global
Returns Actor
Parameters float afX, float afY, float afZ, float afRadius
Documentation Finds the closest living actor within a given radius of a location
Game Version v0.0.0+




FindRandomActor
Script Game
Name FindRandomActor
Kind Function
Flags Native Global
Returns Actor
Parameters float afX, float afY, float afZ, float afRadius
Documentation Finds a random actor within a given radius of a location (may return dead actors)
Game Version v0.0.0+




FindRandomLivingActor
Script Game
Name FindRandomLivingActor
Kind Function
Flags Native Global
Returns Actor
Parameters float afX, float afY, float afZ, float afRadius
Documentation Finds a random living actor within a given radius of a location
Game Version v0.0.0+




FindClosestActorFromRef
Script Game
Name FindClosestActorFromRef
Kind Function
Flags Global
Returns Actor
Parameters ObjectReference arCenter, float afRadius
Documentation Finds the closest actor within a given radius of a reference (may return dead actors)
Game Version v0.0.0+




FindClosestLivingActorFromRef
Script Game
Name FindClosestLivingActorFromRef
Kind Function
Flags Global
Returns Actor
Parameters ObjectReference arCenter, float afRadius
Documentation Finds the closest living actor within a given radius of a reference
Game Version v0.0.0+




FindRandomActorFromRef
Script Game
Name FindRandomActorFromRef
Kind Function
Flags Global
Returns Actor
Parameters ObjectReference arCenter, float afRadius
Documentation Finds a random actor within a given radius of a reference (may return dead actors)
Game Version v0.0.0+




FindRandomLivingActorFromRef
Script Game
Name FindRandomLivingActorFromRef
Kind Function
Flags Global
Returns Actor
Parameters ObjectReference arCenter, float afRadius
Documentation Finds a random living actor within a given radius of a reference
Game Version v0.0.0+




ForceDisableSSRDirLight
Script Game
Name ForceDisableSSRDirLight
Kind Function
Flags Native Global
Returns None
Parameters bool abDisableSSR, bool abDisableDirLight
Documentation Disable SSR, and/or directional lighting. Note: disable state reset after 240 frames if this function is not continually called.
Game Version v0.0.0+




ForceThirdPerson
Script Game
Name ForceThirdPerson
Kind Function
Flags Native Global
Returns None
Documentation Make the player got to 3rd person camera mode
Game Version v0.0.0+




ForceFirstPerson
Script Game
Name ForceFirstPerson
Kind Function
Flags Native Global
Returns None
Documentation Make the player got to 1st person camera mode
Game Version v0.0.0+




GetXPForLevel
Script Game
Name GetXPForLevel
Kind Function
Flags Native Global
Returns int
Parameters int auiLevel
Documentation Return the total amount of XP required to get to the particular level (not the gap between two levels)
Game Version v0.0.0+




ShowFirstPersonGeometry
Script Game
Name ShowFirstPersonGeometry
Kind Function
Flags Native Global
Returns None
Parameters bool abShow = true
Documentation Show the players first person geometry.
Game Version v0.0.0+




ShowAllMapMarkers
Script Game
Name ShowAllMapMarkers
Kind Function
Flags Native Global
Returns None
Documentation Show all the map markers on the world map.
Game Version v0.0.0+




GameplayAutomatedTestComplete
Script Game
Name GameplayAutomatedTestComplete
Kind Function
Flags Native Global DebugOnly
Returns None
Parameters bool abSuccessful
Documentation Tell the code that the gameplay automated test has been completed.
Game Version v0.0.0+




GetAggressionAV
Script Game
Name GetAggressionAV
Kind Function
Flags Native Global
Returns ActorValue
Documentation Get the Aggression Actor Value
Game Version v0.0.0+




GetAgilityAV
Script Game
Name GetAgilityAV
Kind Function
Flags Native Global
Returns ActorValue
Documentation Get the Agility Actor Value
Game Version v0.0.0+




GetAllLocations
Script Game
Name GetAllLocations
Kind Function
Flags Native Global
Returns Location[]
Documentation Returns a list of all Locations
Game Version v0.0.0+




GetMatchingLocations
Script Game
Name GetMatchingLocations
Kind Function
Flags Global Native
Returns Location[]
Parameters Location ParentLocation = none, Keyword[] WantedKeywords = none, Keyword[] UnwantedKeywords = none, LocationRefType[] WantedRefTypes = none, LocationRefType[] UnwantedRefTypes = none, bool MustFindAllWantedKeywords = true, bool MustNotFindAnyUnwantedKeywords = true, bool MustFindAllWantedRefTypes = true, bool MustNotFindAnyUnwantedRefTypes = true, int LimitOfLocationsToReturn = 0
Documentation Returns a list of locations matching the following criteria

ParentLocation - if not none, returns only locations which have this as a parent location WantedKeywords - if not empty, locations must have these keywords UnwantedKeywords - if not empty, locations must not have these keywords WantedRefTypes - if not empty, locations must have references with these LocationRefTypes UnwantedRefTypes - if not empty, locations must not have these RefTypes MustFindAllWantedKeywords - if true, locations must have ALL of the keywords. If false, location must have AT LEAST ONE of the keywords MustNotFindAnyUnwantedKeywords - if true, locations must not have ANY of the keywords. If false, location must not have ALL of the keywords present at the same time MustFindAllWantedRefTypes - if true, locations must have ALL of the RefTypes. If false, location must have AT LEAST ONE of the RefTypes MustNotFindAnyUnwantedRefTypes - if true, locations must not have ANY of the RefTypes. If false, location must not have ALL of the RefTypes present at the same time LimitOfLocationsToReturn - if > 0, randomly select this many locations to return. If <= 0, return all matching locations

Game Version v0.0.0+




GetMatchingLocation
Script Game
Name GetMatchingLocation
Kind Function
Flags Global
Returns Location
Parameters Location ParentLocation = none, Keyword[] WantedKeywords = none, Keyword[] UnwantedKeywords = none, LocationRefType[] WantedRefTypes = none, LocationRefType[] UnwantedRefTypes = none, bool MustFindAllWantedKeywords = true, bool MustNotFindAnyUnwantedKeywords = true, bool MustFindAllWantedRefTypes = true, bool MustNotFindAnyUnwantedRefTypes = true
Documentation No documentation provided.
Game Version v0.0.0+




GetCameraHeadingAngle
Script Game
Name GetCameraHeadingAngle
Kind Function
Flags Native Global
Returns float
Parameters ObjectReference akTarget
Documentation Gets the angle between the camera's heading and the target object in degrees - in the range from -180 to 180
Game Version v0.0.0+




GetCaps
Script Game
Name GetCaps
Kind Function
Flags Global
Returns MiscObject
Documentation Returns the caps misc item
Game Version v0.0.0+




GetCredits
Script Game
Name GetCredits
Kind Function
Flags Global
Returns MiscObject
Documentation No documentation provided.
Game Version v0.0.0+




GetCharismaAV
Script Game
Name GetCharismaAV
Kind Function
Flags Native Global
Returns ActorValue
Documentation Get the Charisma Actor Value
Game Version v0.0.0+




GetConfidenceAV
Script Game
Name GetConfidenceAV
Kind Function
Flags Native Global
Returns ActorValue
Documentation Get the Confidence Actor Value
Game Version v0.0.0+




GetDieRoll
Script Game
Name GetDieRoll
Kind Function
Flags Global
Returns int
Parameters int MinResult = 1, int NumberOfSides = 100, int DebugDieRoll = -1
Documentation Get a die roll result
Game Version v0.0.0+




GetDieRollSuccess
Script Game
Name GetDieRollSuccess
Kind Function
Flags Global
Returns bool
Parameters int Chance, int MinResult = 1, int NumberOfSides = 100, int DebugDieRoll = -1, int ForcedDieRoll = -1
Documentation Get if a die roll result was a success
Game Version v0.0.0+




GetDifficulty
Script Game
Name GetDifficulty
Kind Function
Flags Native Global
Returns int
Documentation Returns the game's current difficulty

Type is as follows: 0 - Very Easy 1 - Easy 2 - Normal 3 - Hard 4 - Very Hard 5 - Survival w/ Hardcore

Game Version v0.0.0+




GetEnduranceAV
Script Game
Name GetEnduranceAV
Kind Function
Flags Native Global
Returns ActorValue
Documentation Get the Endurance Actor Value
Game Version v0.0.0+




GetForm
Script Game
Name GetForm
Kind Function
Flags Native Global
Returns Form
Parameters int aiFormID
Documentation Returns the form specified by the ID
Game Version v0.0.0+




GetFormFromFile
Script Game
Name GetFormFromFile
Kind Function
Flags Native Global
Returns Form
Parameters int aiFormID, string asFilename
Documentation Returns the form specified by the ID originating in the given file
Game Version v0.0.0+




GetGameSettingFloat
Script Game
Name GetGameSettingFloat
Kind Function
Flags Native Global
Returns float
Parameters string asGameSetting
Documentation Obtains the value of a game setting - one for each type of game setting
Game Version v0.0.0+




GetGameSettingInt
Script Game
Name GetGameSettingInt
Kind Function
Flags Native Global
Returns int
Parameters string asGameSetting
Documentation No documentation provided.
Game Version v0.0.0+




GetGameSettingString
Script Game
Name GetGameSettingString
Kind Function
Flags Native Global
Returns string
Parameters string asGameSetting
Documentation No documentation provided.
Game Version v0.0.0+




GetGameSettingUInt
Script Game
Name GetGameSettingUInt
Kind Function
Flags Native Global
Returns int
Parameters string asGameSetting
Documentation No documentation provided.
Game Version v0.0.0+




GetGameSettingBool
Script Game
Name GetGameSettingBool
Kind Function
Flags Native Global
Returns bool
Parameters string asGameSetting
Documentation No documentation provided.
Game Version v0.0.0+




GetHealthAV
Script Game
Name GetHealthAV
Kind Function
Flags Native Global
Returns ActorValue
Documentation Get the Health Actor Value
Game Version v0.0.0+




GetIntelligenceAV
Script Game
Name GetIntelligenceAV
Kind Function
Flags Native Global
Returns ActorValue
Documentation Get the Intelligence Actor Value
Game Version v0.0.0+




GetLuckAV
Script Game
Name GetLuckAV
Kind Function
Flags Native Global
Returns ActorValue
Documentation Get the Luck Actor Value
Game Version v0.0.0+




GetInvulnerableAV
Script Game
Name GetInvulnerableAV
Kind Function
Flags Native Global
Returns ActorValue
Documentation Get the Invulnerable Actor Value
Game Version v0.0.0+




GetPerceptionAV
Script Game
Name GetPerceptionAV
Kind Function
Flags Native Global
Returns ActorValue
Documentation Get the Perception Actor Value
Game Version v0.0.0+




GetPlayer
Script Game
Name GetPlayer
Kind Function
Flags Native Global
Returns Actor
Documentation Returns the player actor
Game Version v0.0.0+




GetPlayerActiveQuests
Script Game
Name GetPlayerActiveQuests
Kind Function
Flags Native Global
Returns Quest[]
Documentation Returns a list of quests that are active on the player
Game Version v0.0.0+




GetPlayerActiveDialogueUnsaidInfo
Script Game
Name GetPlayerActiveDialogueUnsaidInfo
Kind Function
Flags Native Global
Returns int[]
Documentation Returns an array of how many unsaid topics are tied to each dialogue option in the active conversation
Game Version v0.0.0+




GetPlayerFollowers
Script Game
Name GetPlayerFollowers
Kind Function
Flags Native Global
Returns Actor[]
Documentation Returns a list of actors that are following the player (including both those running

a Follow procedure and those flagged by their package to be treated as followers).

Game Version v0.0.0+




GetPlayerLevel
Script Game
Name GetPlayerLevel
Kind Function
Flags Global
Returns int
Documentation Returns the player's level
Game Version v0.0.0+




GetPlayerGrabbedRef
Script Game
Name GetPlayerGrabbedRef
Kind Function
Flags Native Global
Returns ObjectReference
Documentation Returns the reference the player is currently grabbing
Game Version v0.0.0+




GetPlayerRadioFrequency
Script Game
Name GetPlayerRadioFrequency
Kind Function
Flags Native Global
Returns float
Documentation Returns the current frequency setting of the player's radio
Game Version v0.0.0+




GetPlayersLastRiddenHorse
Script Game
Name GetPlayersLastRiddenHorse
Kind Function
Flags Native Global
Returns Actor
Documentation Returns the horse last ridden by the player
Game Version v0.0.0+




GetRealHoursPassed
Script Game
Name GetRealHoursPassed
Kind Function
Flags Native Global
Returns float
Documentation Returns the number of days spent in play
Game Version v0.0.0+




GetSuspiciousAV
Script Game
Name GetSuspiciousAV
Kind Function
Flags Native Global
Returns ActorValue
Documentation Get the Suspicious Actor Value
Game Version v0.0.0+




GetStrengthAV
Script Game
Name GetStrengthAV
Kind Function
Flags Native Global
Returns ActorValue
Documentation Get the Strength Actor Value
Game Version v0.0.0+




GivePlayerCaps
Script Game
Name GivePlayerCaps
Kind Function
Flags Global
Returns None
Parameters int nCaps
Documentation Adds a specified amount of caps to the player
Game Version v0.0.0+




HideContrabandScanWarning
Script Game
Name HideContrabandScanWarning
Kind Function
Flags Native Global
Returns None
Parameters bool abSkipCompletionAnim = false, bool abWasDetectionEvaded = false
Documentation Hides the Contraband Scan Warning, skipping or completing the scan as a success or failure.

If abSkipCompletionAnim is true, abWasDetectionEvaded will be ignored.

Game Version v0.0.0+




HideHudMenus
Script Game
Name HideHudMenus
Kind Function
Flags Native Global
Returns None
Documentation Hides the hud and spaceship hud menus.
Game Version v0.0.0+




RemovePlayerCaps
Script Game
Name RemovePlayerCaps
Kind Function
Flags Global
Returns None
Parameters int nCaps
Documentation Removes a specified amount of caps from the player
Game Version v0.0.0+




IncrementSkill
Script Game
Name IncrementSkill
Kind Function
Flags Native Global
Returns None
Parameters ActorValue akActorValue, int aiCount = 1
Documentation Increment the given skill on the player by the given number of points
Game Version v0.0.0+




IncrementStat
Script Game
Name IncrementStat
Kind Function
Flags Native Global
Returns None
Parameters string asStatName, int aiModAmount = 1
Documentation Modifies the specified MiscStat by the given amount.
Game Version v0.0.0+




IsActivateControlsEnabled
Script Game
Name IsActivateControlsEnabled
Kind Function
Flags Native Global
Returns bool
Documentation Are the activation controls enabled?
Game Version v0.0.0+




IsAutomatedTestControllingPlayerInProgress
Script Game
Name IsAutomatedTestControllingPlayerInProgress
Kind Function
Flags Native Global DebugOnly
Returns bool
Documentation Is there an automated test controlling the player (bot) running currently?
Game Version v0.0.0+




IsVATSControlsEnabled
Script Game
Name IsVATSControlsEnabled
Kind Function
Flags Native Global
Returns bool
Documentation Are the VATS controls enabled?
Game Version v0.0.0+




IsVATSPlaybackActive
Script Game
Name IsVATSPlaybackActive
Kind Function
Flags Native Global
Returns bool
Documentation Is VATS playback active?
Game Version v0.0.0+




IsCamSwitchControlsEnabled
Script Game
Name IsCamSwitchControlsEnabled
Kind Function
Flags Native Global
Returns bool
Documentation Are the camera switch controls enabled?
Game Version v0.0.0+




IsFarTravelControlsEnabled
Script Game
Name IsFarTravelControlsEnabled
Kind Function
Flags Native Global
Returns bool
Documentation Is ship far travel enabled?
Game Version v0.0.0+




IsFastTravelControlsEnabled
Script Game
Name IsFastTravelControlsEnabled
Kind Function
Flags Native Global
Returns bool
Documentation Is fast travel controls enabled? Returns false if EnableFastTravel(false) has been called
Game Version v0.0.0+




IsFastTravelEnabled
Script Game
Name IsFastTravelEnabled
Kind Function
Flags Native Global
Returns bool
Documentation Is fast travel enabled?
Game Version v0.0.0+




IsFavoritesControlsEnabled
Script Game
Name IsFavoritesControlsEnabled
Kind Function
Flags Native Global
Returns bool
Documentation Is favorites menu enabled?
Game Version v0.0.0+




IsGravJumpControlsEnabled
Script Game
Name IsGravJumpControlsEnabled
Kind Function
Flags Native Global
Returns bool
Documentation Is ship grav jump enabled?
Game Version v0.0.0+




IsGuardPursuingPlayer
Script Game
Name IsGuardPursuingPlayer
Kind Function
Flags Native Global
Returns bool
Documentation are any guards pursuing the player for crime?
Game Version v0.0.0+




IsTakeoffControlsEnabled
Script Game
Name IsTakeoffControlsEnabled
Kind Function
Flags Native Global
Returns bool
Documentation Is ship takeoff enabled?
Game Version v0.0.0+




IsFightingControlsEnabled
Script Game
Name IsFightingControlsEnabled
Kind Function
Flags Native Global
Returns bool
Documentation Are the fighting controls enabled?
Game Version v0.0.0+




IsJournalControlsEnabled
Script Game
Name IsJournalControlsEnabled
Kind Function
Flags Native Global
Returns bool
Documentation Are the journal menu controls enabled?
Game Version v0.0.0+




IsJumpingControlsEnabled
Script Game
Name IsJumpingControlsEnabled
Kind Function
Flags Native Global
Returns bool
Documentation Are the jumping controls enabled? (Note: Movement also enables/disables jumping)
Game Version v0.0.0+




IsLookingControlsEnabled
Script Game
Name IsLookingControlsEnabled
Kind Function
Flags Native Global
Returns bool
Documentation Are the looking controls enabled?
Game Version v0.0.0+




IsMenuControlsEnabled
Script Game
Name IsMenuControlsEnabled
Kind Function
Flags Native Global
Returns bool
Documentation Are the menu controls enabled?
Game Version v0.0.0+




IsMovementControlsEnabled
Script Game
Name IsMovementControlsEnabled
Kind Function
Flags Native Global
Returns bool
Documentation Are the movement controls enabled?
Game Version v0.0.0+




IsPluginInstalled
Script Game
Name IsPluginInstalled
Kind Function
Flags Native Global
Returns bool
Parameters string asName
Documentation Is the specified plugin (esm or esp) installed?
Game Version v0.0.0+




IsPlayerInDialogue
Script Game
Name IsPlayerInDialogue
Kind Function
Flags Native Global
Returns bool
Documentation Is the player currently considered in dialogue?
Game Version v0.0.0+




IsPlayerInMessageBox
Script Game
Name IsPlayerInMessageBox
Kind Function
Flags Native Global
Returns bool
Documentation Is the player currently being displayed a message box?
Game Version v0.0.0+




IsPlayerInRadioRange
Script Game
Name IsPlayerInRadioRange
Kind Function
Flags Native Global
Returns bool
Parameters float afFrequency
Documentation Is the player within the outer radius of a transmitter using the given frequency?
Game Version v0.0.0+




IsPlayerListening
Script Game
Name IsPlayerListening
Kind Function
Flags Native Global
Returns bool
Parameters float afFrequency
Documentation Is the player actively listening to a transmitter using the given frequency.

(Pipboy is on, set to a frequency that would receive the transmission, and within the transmitter's outer radius.)

Game Version v0.0.0+




IsPlayerLoitering
Script Game
Name IsPlayerLoitering
Kind Function
Flags Native Global
Returns bool
Documentation Is the player loitering
Game Version v0.0.0+




IsPlayerSpaceshipOwner
Script Game
Name IsPlayerSpaceshipOwner
Kind Function
Flags Native Global
Returns bool
Parameters SpaceshipReference arRef
Documentation Is the player an owner of this spaceship reference
Game Version v0.0.0+




IsPlayerRadioOn
Script Game
Name IsPlayerRadioOn
Kind Function
Flags Native Global
Returns bool
Documentation Is the player's radio currently on?
Game Version v0.0.0+




IsResearchComplete
Script Game
Name IsResearchComplete
Kind Function
Flags Native Global
Returns bool
Parameters ResearchProject akResearchProject
Documentation has the player completed this research project
Game Version v0.0.0+




IsSneakingControlsEnabled
Script Game
Name IsSneakingControlsEnabled
Kind Function
Flags Native Global
Returns bool
Documentation Are the sneaking controls enabled?
Game Version v0.0.0+




PassTime
Script Game
Name PassTime
Kind Function
Flags Native Global
Returns None
Parameters int aiHours
Documentation Pass time as if the player has waited the given number of hours.
Game Version v0.0.0+




PlayBink
Script Game
Name PlayBink
Kind Function
Flags Native Global
Returns None
Parameters string asFileName, bool abInterruptible = false, bool abMuteAudio = true, bool abMuteMusic = true, bool abLetterbox = true, bool abIsNewGameBink = false
Documentation Plays a bink video - does not return until bink has finished, use with care!
Game Version v0.0.0+




PlayBinkNoWait
Script Game
Name PlayBinkNoWait
Kind Function
Flags Native Global
Returns None
Parameters string asFileName, bool abInterruptible = false, bool abMuteAudio = true, bool abMuteMusic = true, bool abLetterbox = true, bool abIsNewGameBink = false, bool aPlayDuringLoadingScreen = false
Documentation Plays a bink video, use with care!
Game Version v0.0.0+




PrecacheCharGen
Script Game
Name PrecacheCharGen
Kind Function
Flags Native Global
Returns None
Documentation Precaches character gen data.
Game Version v0.0.0+




PrecacheCharGenClear
Script Game
Name PrecacheCharGenClear
Kind Function
Flags Native Global
Returns None
Documentation Clears Precached character gen data.
Game Version v0.0.0+




PopPlayerTo
Script Game
Name PopPlayerTo
Kind Function
Flags Native Global
Returns bool
Parameters ObjectReference akTarget, float afXOffset = 0.0, float afYOffset = 0.0, float afZOffset = 0.0, bool abMatchRotation = true, bool abCheckForCollision = false
Documentation Pops the player to the location of the target without any load or screen fade. Note that the target reference must be in the same cell as the player.

If you have to move the player to a reference in another cell, use MoveTo instead.

Game Version v0.0.0+




QueryStat
Script Game
Name QueryStat
Kind Function
Flags Native Global
Returns int
Parameters string asStat
Documentation Queries the given stat and returns its value
Game Version v0.0.0+




QuitToMainMenu
Script Game
Name QuitToMainMenu
Kind Function
Flags Native Global
Returns None
Documentation Forces the game back to the main menu
Game Version v0.0.0+




RemoveFromAvailableCrew
Script Game
Name RemoveFromAvailableCrew
Kind Function
Flags Native Global
Returns None
Parameters Actor akActor
Documentation Removes the specified actor from the player's list of available crew members.
Game Version v0.0.0+




RemovePlayerOwnedShip
Script Game
Name RemovePlayerOwnedShip
Kind Function
Flags Native Global
Returns bool
Parameters SpaceshipReference arRef
Documentation Remove the specified spaceship from the player's owned ships
Game Version v0.0.0+




RequestAutoSave
Script Game
Name RequestAutoSave
Kind Function
Flags Native Global
Returns None
Documentation Request that an auto-save be made
Game Version v0.0.0+




RequestDialogueSkip
Script Game
Name RequestDialogueSkip
Kind Function
Flags Native Global
Returns None
Documentation Request that the dialogue menu skips the current line of dialogue
Game Version v0.0.0+




RequestDialogueExit
Script Game
Name RequestDialogueExit
Kind Function
Flags Native Global
Returns None
Documentation Request that the dialogue menu exits if possible
Game Version v0.0.0+




RequestDialogueSelect
Script Game
Name RequestDialogueSelect
Kind Function
Flags Native Global
Returns None
Parameters int aiIndex
Documentation Request to select a dialogue option
Game Version v0.0.0+




RequestGameplayBotState
Script Game
Name RequestGameplayBotState
Kind Function
Flags Native Global
Returns None
Parameters ObjectReference arRef, int aiState
Documentation Request to start a state with the target refernece
Game Version v0.0.0+




RequestMessageBoxSelect
Script Game
Name RequestMessageBoxSelect
Kind Function
Flags Native Global
Returns None
Parameters int aiIndex
Documentation Request to select a messagebox option
Game Version v0.0.0+




RequestHUDRolloverRefresh
Script Game
Name RequestHUDRolloverRefresh
Kind Function
Flags Native Global
Returns None
Documentation Request that the HUD's rollover refresh itself
Game Version v0.0.0+




RequestModel
Script Game
Name RequestModel
Kind Function
Flags Native Global
Returns None
Parameters string asModelName
Documentation Requests the specified model
Game Version v0.0.0+




RequestSave
Script Game
Name RequestSave
Kind Function
Flags Native Global
Returns None
Documentation Request that a normal save be made
Game Version v0.0.0+




RequestSaveByName
Script Game
Name RequestSaveByName
Kind Function
Flags Native Global DebugOnly
Returns None
Parameters string asSaveName
Documentation Request that a save with a specific name be made
Game Version v0.0.0+




CreateStarbornGame
Script Game
Name CreateStarbornGame
Kind Function
Flags Native Global
Returns None
Documentation Request that the game resets into NG+ with the current player character
Game Version v0.0.0+




RewardPlayerXP
Script Game
Name RewardPlayerXP
Kind Function
Flags Native Global
Returns None
Parameters int auiXPAmount, bool abDirect = false
Documentation Rewards the player with XP, if direct is true, then will ignore various XP adjustments like entry points and intelligence
Game Version v0.0.0+




ServeTime
Script Game
Name ServeTime
Kind Function
Flags Native Global
Returns None
Documentation Has the player serve their prison time
Game Version v0.0.0+




SetCameraTarget
Script Game
Name SetCameraTarget
Kind Function
Flags Native Global
Returns None
Parameters Actor arTarget
Documentation Sets the camera target actor
Game Version v0.0.0+




SetCharGenHUDMode
Script Game
Name SetCharGenHUDMode
Kind Function
Flags Native Global
Returns None
Parameters int aiCGHUDMode
Documentation Sets or clears CharGen-specific HUD modes.
Game Version v0.0.0+




SetHandscannerDistortionLevel
Script Game
Name SetHandscannerDistortionLevel
Kind Function
Flags Native Global
Returns None
Parameters int aLevel
Documentation Sets the distortion level on the handscanner (0-3)
Game Version v0.0.0+




SetInChargen
Script Game
Name SetInChargen
Kind Function
Flags Native Global
Returns None
Parameters bool abDisableSaving, bool abDisableWaiting, bool abShowControlsDisabledMessage
Documentation Informs the game whether we are in CharGen or not
Game Version v0.0.0+




SetPlayerAIDriven
Script Game
Name SetPlayerAIDriven
Kind Function
Flags Native Global
Returns None
Parameters bool abAIDriven = true
Documentation Enables or disables the AI driven flag on Player
Game Version v0.0.0+




SetPlayerOnElevator
Script Game
Name SetPlayerOnElevator
Kind Function
Flags Native Global
Returns None
Parameters bool abOnElevator = true
Documentation Enables or disables the Player on Elevator flag
Game Version v0.0.0+




TrySetPlayerHomeSpaceShip
Script Game
Name TrySetPlayerHomeSpaceShip
Kind Function
Flags Native Global
Returns bool
Parameters ObjectReference akHomeShip
Documentation Attempts to set the player's home ship
Game Version v0.0.0+




GetPlayerHomeSpaceShip
Script Game
Name GetPlayerHomeSpaceShip
Kind Function
Flags Native Global
Returns SpaceshipReference
Documentation Gets the home ship of the player
Game Version v0.0.0+




GetPlayerOwnedShips
Script Game
Name GetPlayerOwnedShips
Kind Function
Flags Native Global
Returns SpaceshipReference[]
Documentation Gets spaceships the player owns
Game Version v0.0.0+




SetPlayerRadioFrequency
Script Game
Name SetPlayerRadioFrequency
Kind Function
Flags Native Global
Returns None
Parameters float afFrequency
Documentation Sets the player's radio's current frequency
Game Version v0.0.0+




SetPlayerReportCrime
Script Game
Name SetPlayerReportCrime
Kind Function
Flags Native Global
Returns None
Parameters bool abReportCrime = true
Documentation Enables or disables crime reporting on Player
Game Version v0.0.0+




SetSittingRotation
Script Game
Name SetSittingRotation
Kind Function
Flags Native Global
Returns None
Parameters float afValue
Documentation Set the players sitting camera rotation - in degrees, offset from the standard angle.
Game Version v0.0.0+




ShakeCamera
Script Game
Name ShakeCamera
Kind Function
Flags Native Global
Returns None
Parameters ObjectReference akSource = none, float afStrength = 0.5, float afDuration = 0.0
Documentation 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.

Game Version v0.0.0+




ShakeController
Script Game
Name ShakeController
Kind Function
Flags Native Global
Returns None
Parameters float afSmallMotorStrength, float afBigMotorStreangth, float afDuration
Documentation Shakes the controller for the specified length of time (in seconds). The strength values are clamped from 0 to 1
Game Version v0.0.0+




SetLocalTime
Script Game
Name SetLocalTime
Kind Function
Flags Native Global
Returns None
Parameters float afLocalTime
Documentation Rotates the current planet such that the local time will match the specified time
Game Version v0.0.0+




GetLocalTime
Script Game
Name GetLocalTime
Kind Function
Flags Native Global
Returns float
Documentation Get the local time in normalized 24-hour day scale for this planet
Game Version v0.0.0+




ShowContrabandScanWarning
Script Game
Name ShowContrabandScanWarning
Kind Function
Flags Native Global
Returns None
Parameters int aiChanceToEvadeDetection, bool abScanInProgress = false
Documentation Shows the Contraband Scan Warning.

aiChanceToEvadeDetection: an integer representing the percent to evade detection. abScanInProgress: a boolean that specifies whether a security scan is in progress.

Game Version v0.0.0+




ShowCustomWatchAlert
Script Game
Name ShowCustomWatchAlert
Kind Function
Flags Native Global
Returns None
Parameters string aAnimName
Documentation Shows a custom watch animation on the HUD watch
Game Version v0.0.0+




ShowFatigueWarningOnHUD
Script Game
Name ShowFatigueWarningOnHUD
Kind Function
Flags Native Global
Returns None
Documentation Causes the Fatigue Warning to show on the HUD
Game Version v0.0.0+




ShowMissionBoardMenu
Script Game
Name ShowMissionBoardMenu
Kind Function
Flags Native Global
Returns None
Parameters Keyword akFilterByKeyword = none, int iFaction = -1
Documentation Opens the mission board menu with an optional keyword parameter to filter the list
Game Version v0.0.0+




ShowRaceMenu
Script Game
Name ShowRaceMenu
Kind Function
Flags Native Global
Returns None
Parameters ObjectReference akMenuTarget = none, int uiMode = 0, ObjectReference akMenuSpouseFemale = none, ObjectReference akMenuSpouseMale = none, ObjectReference akVendor = none
Documentation Displays the race/sex menu
Game Version v0.0.0+




ShowGalaxyStarMapMenu
Script Game
Name ShowGalaxyStarMapMenu
Kind Function
Flags Native Global
Returns None
Documentation Shows the Galaxy Star Map menu.
Game Version v0.0.0+




ShowTitleSequenceMenu
Script Game
Name ShowTitleSequenceMenu
Kind Function
Flags Native Global
Returns None
Documentation Title Sequence menu functions
Game Version v0.0.0+




HideTitleSequenceMenu
Script Game
Name HideTitleSequenceMenu
Kind Function
Flags Native Global
Returns None
Documentation No documentation provided.
Game Version v0.0.0+




StartTitleSequence
Script Game
Name StartTitleSequence
Kind Function
Flags Native Global
Returns None
Parameters string asSequenceName
Documentation No documentation provided.
Game Version v0.0.0+




TriggerScreenBlood
Script Game
Name TriggerScreenBlood
Kind Function
Flags Native Global
Returns None
Parameters int aiValue
Documentation Trigger screen blood with the given count
Game Version v0.0.0+




PlayEventCamera
Script Game
Name PlayEventCamera
Kind Function
Flags Native Global
Returns None
Parameters CameraShot akCamera, ObjectReference akRef
Documentation Play an event camera
Game Version v0.0.0+




StartDialogueCameraOrCenterOnTarget
Script Game
Name StartDialogueCameraOrCenterOnTarget
Kind Function
Flags Native Global
Returns None
Parameters ObjectReference akCameraTarget = none
Documentation start dialogue camera if in third person or in dialogue camera or swing the camera to speaker if in 1st
Game Version v0.0.0+




StopDialogueCamera
Script Game
Name StopDialogueCamera
Kind Function
Flags Native Global
Returns None
Parameters bool abConsiderResume = false, bool abSwitchingTo1stP = false
Documentation Stop dialogue camera
Game Version v0.0.0+




TurnPlayerRadioOn
Script Game
Name TurnPlayerRadioOn
Kind Function
Flags Native Global
Returns None
Parameters bool abRadioOn = true
Documentation Turns on/off the player's radio
Game Version v0.0.0+




UsingGamepad
Script Game
Name UsingGamepad
Kind Function
Flags Native Global
Returns bool
Documentation Returns true if we're using a gamepad
Game Version v0.0.0+




Warning
Script Game
Name Warning
Kind Function
Flags Native Global BetaOnly
Returns None
Parameters string asMessage
Documentation Issue a warning to the script log and warning system
Game Version v0.0.0+