Glossary
A glossary of terms used in these documents.
A base script or base import refers to scripts included with the Creation Kit.
A code convention is the practice of naming and organizing source code in a conform manner. With an online search you will find many topics related to code conventions from many points of view. A large portion of these code conventions are applicable to Papyrus, but some may not apply, or require an approximation.
For example, the Microsoft Naming Guidelines and Microsoft Coding Conventions may have a positive influence on the scripts you write.
A command line interface (CLI) is a means of interacting with a computer program where the user issues commands to the program in the form of successive lines of text (command lines). Most people will recognize the Windows Command Prompt as an example of a common CLI. Read more about Command Line Interfaces on Wikipedia.
The Language Server Protocol (LSP) is an open, JSON-RPC-based protocol for use between IDEs and servers that provide programming language-specific features. The goal of the protocol is to allow programming language support to be implemented and distributed independently of any given editor or integrated development environment. Read more about Language Server Protocol on Wikipedia.
An integrated development environment (IDE) is a software application for editing source code. An IDE also provides comprehensive facilities to computer programmers for software development. An IDE normally consists of at least a source code editor, build automation tools, and a debugger. Read more about Integrated Development Environments on Wikipedia.
The user folder is the default import for user created scripts.
An import folder is a directory of Papyrus source files and namespaces.
The import root is the directory where namespaces will resolve their paths.
The installation, or installation directory refers to where the Game, Creation Kit, or any software is installed. Typically this is the directory where executables (.exe) are located.
...\<INSTALL>\*.exe
The term installation may also refer to the act of performing an installation of software.
A mod manager is used to download, install, and verify the integrity of mod files.
In computing, the modulo operation finds the remainder after division of one number by another. This is called the modulus of the operation. Read more about Modulo Operations on Wikipedia.
Refers to the Microsoft Windows "My Documents" folder.
On some versions of windows this may be Documents\ instead of My Documents\.
This is a part of your script's "type".
A package refers to all the files included with a project including non-source. This is typically in the context of a Mod Manager.
A project refers to the modification your working on.
A release, REL, or RELz is a Project which provides a stable, publicly available distribution.
Read more about why WIPz & RELz has a "z" character suffix.
The Script Extender family of projects have existed for many years with support for titles reaching back to Morrowind and beyond.
Because of this, each Script Extender has adopted a naming scheme of the game's prefix followed by SE.
For example, the Script Extender project for Skyrim is called SKSE, Fallout 4 is called F4SE, or just xSE to refer to the project in general.
Although some elements of the Script Extender source code has been carried from one game to another, each is essentially a standalone project. The Script Extender project is graciously hosted by SilverLock, visit the official websites for SKSE and F4SE.
- See also an Overview of SKSE.
- See also an Overview of F4SE.
A symbol in computer programming is a primitive data type whose instances have a unique human-readable form. Symbols can be used as identifiers. In some programming languages, they are called atoms. Uniqueness is enforced by holding them in a symbol table. Read more about Symbols on Wikipedia.
A work in progress, WIP, or WIPz is a Project which is in active development. As a natural part of the development cycle, some features may not exist, or do not work as intended. When a project is completed it will graduate to a released project.
So why the "z" character at the end of "WIPz" you may be asking?
Some time ago, it was popular to post work in progress and release projects on forums popular within the community.
The forum software back then was also older.
A forum thread naming scheme emerged because the forum search would not allow a search phrase of less than four characters in length.
So it became common place for authors to post project threads with a "z" on the end of "REL" and "WIP" in order to make their threads searchable.
At some point most communities upgraded their forum software to support searches of less than three characters, yet the tradition remained.
The Creation Engine is a 3D video game engine created by Bethesda Game Studios based on the Gamebryo Engine. The Creation Engine has been used to create role-playing video games such as Skyrim, Fallout 4, and Fallout 76. Read more about the Creation Engine on Wikipedia.
Elements of the Creation Engine can be manipulated with the Creation Kit. The Creation Engine covers many terms and topics, some of which are listed below.
An Actor is a type of Creation Engine Game Object.
An Armor is a type of Creation Engine Game Object.
A game object is a type used by the Creation Engine. These types can be edited and created with the Creation Kit.
A Weapon is a type of Creation Engine Game Object.
A Quest is a type of Creation Engine Game Object.
Visual Studio Code is a lightweight but powerful source code editor which runs on your desktop. To get the most out of Visual Studio Code, start by reviewing a few introductory topics in the VS Code Documentation.
Extension
Features
- Language Definition
- IntelliSense
- Code Navigation
- Refactoring
- Compilation
-
Debugging
- Debug View
- [Debug Console](Debug Console)
- [Assembly View](Assembly View)
Creation Engine
Language
Help