2 posts / 0 new
Last post
0siribix
0siribix's picture
Contributor
Offline
Last seen: 3 years 5 months ago
Joined: 01/23/2016 - 16:20
Karma: 28
Papyrus Script Template

Please use this template when developing new scripts. The attached file includes the template without all the notes. If anyone has any comments/complaints/suggestions, please reply here or message me on Discord

Scriptname skmw_<script name><number><form type>Script extends <form>
{Description of the purpose of this script. Include that this is for Skywind and which version of Skywind}

;/
    List of Contributers
    Notes to future contributers
/;

; Put properties here. Comment each property that isn't completely obvious with a description of what it is used for
 

; Comment using {} under each Property
; If you add properties using the CK, it will add it to the tail of the source file but it is fine to cut and paste it at the top

; Next section is global variables. Comment with ;  or ;/~/;

; Next section is Events, then Functions. If you define states, keep the events and functions in the same order in each state

; Either camelCase or CamelCase is acceptable in your code
; If you have not read the Scripting Tutorial, you should. There is great information in there even for veteran scripters
; http://www.nexusmods.com/skyrim/mods/70883/

; Script should be the same name as the object it is attached to if possible
; If not, use a shortened form of that name but keep it as unambiguous as possible
; Try to use the name from the CK as opposed to the in-game name
;
;
; Number is optional and only needed if there are/will be more than one type with this name
; If you have multiple scripts attached to the same object then you can name them 1a, 1b, 1c, etc
;
; Form type is the type of form this script is attached to
; Quest
; Activator
; ObRef
; Actor
;
; Every script should end with the word Script because you cannot name a script the same as any other object in the game
; The Script name MUST be the filename without extension or it will not compile
; skmw_Mq101QuestScript must have the filename skmw_Mq101QuestScript.psc
; Variable names should include an identifier. While we won't require a convention, it should be clear what each one is used for
; Please use either standard prefixes like int, frm, bool or use BethSoft's own convention
; a : Argument :: b : Bool :: f : Float :: i : Int :: s : String :: k : Everything Else
; In addition, let's add y for array
; So a function argument that is an array of floats would be float[] afyMyArray
;
;
; Example names
; skmw_Mq101QuestScript
; MQ101, attached to the quest
; skmw_Fur_cuirassArmorScript
; Script attached to fur_cuirass

AttachmentSize
Plain text icon script_template.txt754 bytes
Edited by: 0siribix on 03/17/2016 - 19:57
0siribix
0siribix's picture
Contributor
Offline
Last seen: 3 years 5 months ago
Joined: 01/23/2016 - 16:20
Karma: 28
Updated to remove redundant

Updated to remove redundant information handled by the version tracker