Difference between revisions of "Default Scripts List"
no edit summary
imported>Exit |
imported>Matthiaswagg |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
This is a full list of all default scripts included in vanilla Skyrim. | This is a full list of all default scripts included in vanilla Skyrim. | ||
Defaults scripts are pre-created and compiled scripts written by the Bethesda developers, made with the intention of saving the time of a modder spent writing scripts to perform common tasks. They can be added to any record by going to Scripts>Add, filtering by "default" and choosing one of the scripts to add. Often, they contain properties that should be filled in order for the script to function properly. | Defaults scripts are pre-created and compiled scripts written by the Bethesda developers, made with the intention of saving the time of a developer or modder spent writing scripts to perform common tasks. They can be added to any record by going to Scripts>Add, filtering by "default" and choosing one of the scripts to add. Often, they contain properties that should be filled in order for the script to function properly. | ||
See the [[Glossary]] for more information on specific terms. | See the [[Glossary]] for more information on specific terms. | ||
| Line 591: | Line 591: | ||
'''defaultSetStageActorRefScript''' | '''defaultSetStageActorRefScript''' | ||
This script will set the specified stage on the specified quest (with optional prerequisite stage) if the proper event is called on the | This script will set the specified stage on the specified quest (with optional prerequisite stage) if the proper event is called on the actor. Possible events are OnActivate, OnDeath, OnHit, OnTriggerEnter, OnEquipped, OnCombatBegin, OnCellLoad, self added to player inventory, self removed from player inventory, OnOpen, or OnRead. | ||
'''defaultsetStageActRefAliasScript''' | '''defaultsetStageActRefAliasScript''' | ||
This script will set the specified stage of the quest upon activation, with an optional prerequisite stage, after a modifiable delay. Then, it enters a [[States (Papyrus|state]] wherein activation does nothing. ''This only works for Reference Aliases.'' I.e. activating a shrine and setting a stage. | |||
'''defaultsetStageActSCRIPT''' | '''defaultsetStageActSCRIPT''' | ||
This script will set the specified stage of the quest upon activation, with an optional prerequisite stage, after a modifiable delay. Then, it enters a [[States (Papyrus|state]] wherein activation does nothing. | |||
'''defaultsetStageAliasScript''' | '''defaultsetStageAliasScript''' | ||
This script will set the specified stage on the specified quest (with optional prerequisite stage) if the proper event is called on the alias. Possible events are OnActivate, OnDeath, OnHit, OnTriggerEnter, OnEquipped, OnCombatBegin, OnCellLoad, self added to player inventory, self removed from player inventory, OnOpen, or OnRead. ''Only works for Reference Aliases.'' | |||
'''defaultSetStageOnAttacked''' | '''defaultSetStageOnAttacked''' | ||
This script will set the specified stage in the specified quest when the actor has been hit the specified number of times. I.e. complete a quest when you've hit your rival enough. | |||
'''defaultSetStageOnAttackedRefAlias''' | '''defaultSetStageOnAttackedRefAlias''' | ||
This script will set the specified stage in the specified quest when the alias has been hit the specified number of times.''Only works for Reference Aliases.'' I.e. complete a quest when you've hit your rival enough. | |||
'''defaultSetStageOnCloseBook''' | '''defaultSetStageOnCloseBook''' | ||
This script will set the specified stage in the owning quest when you read (NOT close, open) the book this alias references. ''Only works for Reference Aliases.'' | |||
'''defaultSetStageOnCloseBookNotAlias''' | '''defaultSetStageOnCloseBookNotAlias''' | ||
This script will set the specified stage in the specified quest when you read (NOT close, open) the book. | |||
'''defaultSetStageOnDeath''' | '''defaultSetStageOnDeath''' | ||
This script will set the specified stage in the specified quest when this actor dies. I.e. setting a new stage when the boss dies. | |||
'''defaultSetStageOnDeathRefAlias''' | '''defaultSetStageOnDeathRefAlias''' | ||
This script will set the specified stage in the specified quest when this alias dies. I.e. failing the quest when the main quest character dies. | |||
'''defaultSetStageOnEnter''' | '''defaultSetStageOnEnter''' | ||
This script will set a stage on the specified quest when the specified reference(s) are in the triggerbox. ''This will only work on triggerboxes.'' | |||
'''defaultsetStageOnHitAliasScript''' | '''defaultsetStageOnHitAliasScript''' | ||
This script will set a specified stage on the owning quest when the alias is hit. ''This will only work on Reference Aliases.'' | |||
'''defaultSetStageOnLoad''' | '''defaultSetStageOnLoad''' | ||
This script will set the specified stage on the specified quest when the object's [[OnLoad - ObjectReference|3D is loaded]],. | |||
'''defaultsetStageOnOpenSCRIPT''' | '''defaultsetStageOnOpenSCRIPT''' | ||
This script will set the specified stage on the specified quest when the container or door is opened. I.e. setting a stage when you open a chest containing an artifact. | |||
'''defaultSetStageOnPlayerAcquire''' | '''defaultSetStageOnPlayerAcquire''' | ||
This script will set the specified stage on the specified quest when the alias is added to the player's inventory. Then it goes to a [[States (Papyrus)|state]] wherein being readded does nothing. ''Only works on Reference Aliases.'' I.e. completing a stage when you've gathered a weapon. | |||
'''defaultSetStageOnPlayerAcquireItem''' | '''defaultSetStageOnPlayerAcquireItem''' | ||
This script will set the specified stage on the specified quest when the item is added to the player's inventory. Then it goes to a [[States (Papyrus)|state]] wherein being readded does nothing. I.e. starting a quest when you pick up a package. | |||
'''defaultSetStageOnReset''' | '''defaultSetStageOnReset''' | ||
This script sets the specified stage on the specified quest when the object's cell is [[OnReset - ObjectReference|reset]], and optionally disables itself, then goes to a [[States (Papyrus)|state]] wherein resets do nothing. | |||
'''defaultSetStageOnUnload''' | '''defaultSetStageOnUnload''' | ||
This script sets the specified stage on the specified quest when the object is [[OnUnload - ObjectReference|unloaded]]. | |||
'''defaultsetStageRefScript''' | '''defaultsetStageRefScript''' | ||
This script is functionally identical to defaultSetStageAliasScript. | |||
'''defaultSetStageTrigOnLeaveSCRIPT''' | '''defaultSetStageTrigOnLeaveSCRIPT''' | ||
This script will set the specified stage on the specified quest when the trigger is left. ''This only works on triggerboxes.'' I.e. setting a stage when you leave an arena. | |||
'''defaultsetStageTrigSCRIPT''' | '''defaultsetStageTrigSCRIPT''' | ||
This script will set the specified stage on the specified quest when the trigger is entered. ''This only works on triggerboxes.'' I.e. setting a stage when you enter a maze. | |||
'''defaultSetStageTRIGSpecificActor''' | '''defaultSetStageTRIGSpecificActor''' | ||
This script will set the specified stage on the specified quest when the trigger is entered by a specific actor. ''This only works on triggerboxes.'' I.e. setting a stage when you enter a maze. | |||
'''defaultSetStageTRIGSpecificFaction''' | '''defaultSetStageTRIGSpecificFaction''' | ||
This script will set the specified stage on the specified quest when the trigger is entered by a member of a specific faction. ''This only works on triggerboxes.'' I.e. setting a stage when you enter a maze. | |||
'''defaultSoundControlScript''' | '''defaultSoundControlScript''' | ||
This script contains several functions related to playing sounds by name. | |||
'''defaultStartSceneAterDelayTrigScript''' | '''defaultStartSceneAterDelayTrigScript''' | ||
This script will start a scene after a customizable delay when the trigger is entered by the specified actor. ''This only works on triggerboxes.'' I.e. starting an assassination scene when you get close enough to see. | |||
'''defaultStartSceneIfNoCombatTrigScript''' | '''defaultStartSceneIfNoCombatTrigScript''' | ||
This script will start a specified scene when the trigger is entered by the specific actor, and that actor is not in combat. ''This only works on triggerboxes.'' I.e. starting a reunion scene when the player isn't in combat, and close enough. | |||
'''defaultStartSceneOnAliasDeath''' | '''defaultStartSceneOnAliasDeath''' | ||
This script will start a specified scene when an alias dies. ''This only works on Reference Aliases.'' I.e. a scene with a gathering of people around the dead person. | |||
'''defaultStartSceneScript''' | '''defaultStartSceneScript''' | ||
This script will start a specified scene upon activation of the reference. I.e. someone coming up to and opening a gate when you pull a lever. | |||
'''defaultStartSceneTrigAliasScript''' | '''defaultStartSceneTrigAliasScript''' | ||
This script will start the specified scene when triggered by the specified alias. ''Only works with triggerboxes. A specific alias MUST be defined.'' I.e. starting a battle when the king arrives. | |||
'''defaultStartSceneTrigScript''' | '''defaultStartSceneTrigScript''' | ||
This script will start the specified scene when triggered by the specified actor. ''Only works with triggerboxes. A specific actor MUST be defined.'' I.e. starting a verbal debate when the second contestant arrives. | |||
'''defaultStopSceneOnHit''' | '''defaultStopSceneOnHit''' | ||
This script will stop the specified scene when the actor the script is on is [[OnHit - ObjectReference|hit]]. I.e. stopping a peace meeting if you attack one of the negotiators. | |||
'''defaultTeleportAbility''' | '''defaultTeleportAbility''' | ||
''Note from script: Attempt at a generic script for NPCs to teleport to markers when threatened by melee.'' This script should make the caster of the spell teleport to a reference more than 512 units away from the aggressor hitting them if the hits have gone above their hit tolerance. They will also teleport to a reference closer if there's no other options. ''Unsure if it works?'' | |||
'''defaultToggleSelfOnActivate''' | '''defaultToggleSelfOnActivate''' | ||
This script will toggle its own enable state when activated. I.e. for use on [[Reference#Enable Parent|enable parents]]. | |||
'''defaultUnlockOnLoad''' | '''defaultUnlockOnLoad''' | ||
This script will unlock [[OnLoad - ObjectReference]] if the specified quest has passed the specified stage. ''Only works on unlockable things (containers, doors).'' | |||
'''defaultWerewolfAttachPointSCRIPT''' | '''defaultWerewolfAttachPointSCRIPT''' | ||
??? | |||