SkookumScript documentation

Welcome to our splendid and ever-growing trove of SkookumScript documentation! Whether you are a high-level scripter, low-level engine coder, mid-level jack-of-all-trades or miscellaneous dabbler, here ye shall find a comprehensive guide to SkookumScript and the SkookumSuite.

In addition to the pages in this section, see Show me some code! for examples of SkookumScript syntax and brief yet evocative descriptions of the language. See SkookumScript code in action on the Demo videos page.

Table of contents

• Unreal Engine 4 Plugin installation and setup
• SkookumScript Primer Start here!
• Unreal Engine 4 Plugin quick start
• Curated Forum posts

Tutorials

• SkookumScript intro tutorials
  • Create your first routine in a new project
• SkookumScript UE4 Plugin tutorials
  • Basic Tutorial 1: Create and rotate a cube Blueprint
  • Basic Tutorial 2: Spawn cubes dynamically and manipulate them
  • Basic Tutorial 3: Create SkookumScript nodes for use in Blueprints
  • Intermediate Tutorial 1: Combat - SkookumScript vs Blueprints

SkookumIDE

• Widgets (tab views)
  • Workbench (REPL)
    • Parser error checking
  • Log
  • Classes
  • Members
    • New Class or Member pane
  • Overlays
  • Editors
  • Errors
• Advanced
  • Command line arguments
    • (give other applications scripting superpowers!)
  • Communicating with remote runtimes
    • (IP addresses for console, mobile and multiplayer)

SkookumScript Unreal Engine 4 Plugin

• Set up a UE4 project to use SkookumScript
• Add SkookumScript to a UE4 C++ project
• Instance-specific scripts

Language reference

• General
  • Syntax
  • Expressions
  • Whitespace
  • Comments /* */ //
  • Type system
• Literals
  • List
  • Closure ^[ ] or ()[ ]
    • (akin to anonymous function/delegate)
• Invocations
  • Routines
• Identifiers
  • Data members
    • Why @ and @@ for data?
  • Object IDs
• Flow control
  • Code block [ ]
  • Conditionals if, when, unless, case
  • Concurrency
    • Concurrent commands
    • Mind objects and the Master Mind
• Primitives
  • Conversion
• Layout and files
  • Class meta files
  • Overlays
    • (akin to libraries)

Runtime

• Add-on features
  • Demand Script Loading

Extending SkookumScript

• End-user modding
• Calling from C++ to SkookumScript

There’s more on the SkookumScript Forum

These docs are a work-in-progress—much more is on the way! In the meantime, if you can’t find what you are looking for here, check out these curated posts on the SkookumScript Forum, which contain useful information we haven’t yet added to our official docs.

If you have questions or suggestions, or a tip you think others would find useful, please post about it on the SkookumScript Forum. Your input may guide future revisions of these docs.

Next → Unreal Engine 4 Plugin installation and setup