Difference between revisions of "Game Script"

1,564 bytes added ,  12:28, 15 September 2022
Added missing F4SE GetCameraState() function
imported>Plplecuyer
 
(Added missing F4SE GetCameraState() function)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Scripting]]
Collection of game-specific global functions.
[[Category:Papyrus]]
[[Category:Script Objects]]
 
Collection of game-specific global functions


== Definition ==
== Definition ==
Line 12: Line 8:
== Properties ==
== Properties ==
None
None
== Structs ==
None
== F4SE Structs ==
*Struct [[PluginInfo Struct - Game|PluginInfo]]
**A structure that holds information about a plugin.


== Global Functions ==
== Global Functions ==
Line 138: Line 141:
*bool Function [[IsJournalControlsEnabled - Game|IsJournalControlsEnabled]]()
*bool Function [[IsJournalControlsEnabled - Game|IsJournalControlsEnabled]]()
**Are the journal menu controls enabled?
**Are the journal menu controls enabled?
*bool Function [[IsJumpingControlsEnabled - Game|IsJumpingControlsEnabled]]()
**Are the jumping controls enabled?
*bool Function [[IsLookingControlsEnabled - Game|IsLookingControlsEnabled]]()
*bool Function [[IsLookingControlsEnabled - Game|IsLookingControlsEnabled]]()
**Are the looking controls enabled?
**Are the looking controls enabled?
Line 240: Line 245:
*Function [[Warning - Game|Warning]](string asMessage)
*Function [[Warning - Game|Warning]](string asMessage)
**Emits a warning to the papyrus log and the game warning system.
**Emits a warning to the papyrus log and the game warning system.
== F4SE Global Functions ==
*Int Function [[GetCameraState - Game|GetCameraState]]()
**Returns the current player camera state.
*ObjectReference Function [[GetCurrentConsoleRef - Game|GetCurrentConsoleRef]]()
**Returns the current console reference.
*PluginInfo[] Function [[GetInstalledPlugins - Game|GetInstalledPlugins]]()
**Returns an array of currently installed esm and esp files.
*PluginInfo[] Function [[GetInstalledLightPlugins - Game|GetInstalledLightPlugins]]()
**Returns an array of currently installed esl files.
*string[] Function [[GetPluginDependencies - Game|GetPluginDependencies]](string asPluginName)
**Returns an array of plugin dependencies for the specified plugin.
*Function [[SetGameSettingBool - Game|SetGameSettingBool]](string asSetting, bool abValue)
**Set the value of a boolean GameSetting.
*Function [[SetGameSettingFloat - Game|SetGameSettingFloat]](string asSetting, float afValue)
**Set the value of a float GameSetting.
*Function [[SetGameSettingInt - Game|SetGameSettingInt]](string asSetting, int aiValue)
**Set the value of an int GameSetting.
*Function [[SetGameSettingString - Game|SetGameSettingString]](string asSetting, string asString)
**Set the value of a string GameSetting.


== Member Functions ==
== Member Functions ==
None
== F4SE Member Functions ==
None
None


== Events ==
== Events ==
None
None
== See Also ==
*[[Data_File|Data Files]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
14

edits