Open main menu
Home
Random
Log in
Settings
About the CreationKit Wiki
Disclaimers
the CreationKit Wiki
Search
Editing
Adding Working Scripts to Items
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
[[Category:Tutorials]] [[Category:Community Tutorials]] ===What it does:=== This tutorial will go step-by-step to adding a simple script to an item-- gloves that grant you the Blizzard spell while wearing them. ===Create the item=== First, you want to create the gloves. Let's say our gloves are Elven Gauntlets of Thalmor origin. The fields I edited are highlighted in red. [[File:AddingScriptsToItems-NewItem.jpg|200px|thumb|none|alt=Container window settings|Create an Item]] ===Writing the script=== Now that the easy part is done, we will move on to the difficult part. From Gameplay at the top select [[Papyrus Script Manager]], right click on a script and select New. You will be greeted with a dialogue box. (''You could also add the script from the item window by pressing "Add" on the script section and choosing ''<nowiki>[New Script]</nowiki>'', that way it will default to the right type'') [[File:AddingScriptsToItems-NewScript.jpg|200px|thumb|none|alt=Container window settings|Create a Script]] Because it's an item, it must extend [[ObjectReference_Script|ObjectReference]]. Because [[OnEquipped_-_ObjectReference|OnEquipped]] is an event that will be called natively for ObjectReferences, we will be able to use it in this script. Now we can simply write out our script and save it. This is the ScriptName declaration, and its documentation comment: <syntaxhighlight lang="papyrus"> ScriptName tutGlovesofBlizzardScript extends ObjectReference {OnEquip adds a spell} </syntaxhighlight> In order to use things like [[AddSpell - Actor|AddSpell]] and [[AddItem - ObjectReference|AddItem]], you have to make a [[Variables_and_Properties|property]] for them in your script. If you don't do this, you will get an "undefined variable" error. <syntaxhighlight lang="papyrus"> Spell Property Blizzard auto </syntaxhighlight> This next snippet our OnEquipped event. It is important, if this event is being used, that the script extends ObjectReference, or another script that extends ObjectReference (like [[Actor Script|Actor]]), or else the the event will never fire. <syntaxhighlight lang="papyrus"> Event OnEquipped(Actor akActor) If (akActor == Game.GetPlayer()) Game.GetPlayer().AddSpell(Blizzard) EndIf EndEvent </syntaxhighlight> This is simply another event, [[OnUnequipped - ObjectReference|OnUnequipped]] using the same property to remove the spell when the player unequips our scripted gloves. We only want them to have the spell if they wear it. <syntaxhighlight lang="papyrus"> Event OnUnequipped(Actor akActor) If (akActor == Game.GetPlayer()) Game.GetPlayer().RemoveSpell(Blizzard) EndIf EndEvent </syntaxhighlight> Now that our script is finished, we can save it. If you've done everything correctly, yours should compile as flawlessly as this example. ===Attaching the Script=== Now, we go back to our gloves in the Creation Kit, and add the script, edit the property and select the spell that will stand in for the Blizzard property. [[File:AddingScriptsToItems-AttachScript.jpg|200px|thumb|none|alt=Container window settings|Attach the Script]] ===Testing In Game=== Now that our script has been set up in the Creation Kit, we can test it. I added the gloves in to the game by allowing the players to combine normal elven gauntlets with Frost Salts at the Forge. You can use any method you want to put them in the game, including the console (use the [[Help]] command to find the right formID, and [[AddItem|player.AddItem]] to add them to the player). Everything looks good on the gauntlets so far, and when we equip them our script runs successfully. [[File:AddingScriptsToItems-InGame.jpg|200px|thumb|none|alt=Container window settings|View Ingame]] This concludes the tutorial, and I hope it helped people avoid a lot of frustration.
Summary:
Please note that all contributions to the CreationKit Wiki are considered to be released under the Creative Commons Attribution-ShareAlike (see
CreationKit:Copyrights
for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource.
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)