Read the SkookumScript Primer to level up!

Noolarch · 2017-12-20 01:45:17 UTC

The Primer in the online docs has been up since August 2017 though many of you have probably not read it or even known of its existence.

You might have read the earlier docs that were available and not realized that more docs continue to be added.

The Primer may be a single web page, though don’t let that fool you, there is a lot of content – it would be about 71 standard paper pages. (Currently 17800 words at 250 words/page = 71 pages.)

Each section builds on the previous sections and they are all numbered to make it easier to refer to a specific section.

It is still a work in progress, though there is lots of good stuff to cram knowledge into your noggin.

So please read the online Primer and give any feedback you might have on this forum thread.

Enjoy!

The next sections to be added will be:

Flow Control
- Code block
  - Scoping
- Looping and iteration
  - loop and exit
  - Closure based iteration
- Conditionals
- Concurrent blocks: sync, race, branch
Classes, objects and members
- Classes
  - Generic Classes: _ThisClass, _ItemClass, _Auto
- Data members
- Methods
  - calling superclass methods
  - constructors
    - calling superclass constructors
  - destructors
  - conversion methods
- Coroutines
Memory management
- Automatic Reference Counting

cronofear · 2017-12-20 12:17:52 UTC

Please, add a “new” label to each new section when updated. It will be easier to keep track of it .

Also, it would be nice if more - documentation were added or at least information about it. I.e, if i’m not wrong it’s not possible to return more than 1 variable using &blueprint methods in the current version. Or what about passing variables by ref in blueprints, etc.

Noolarch · 2017-12-21 18:28:48 UTC

Thanks for the feedback!

Sure - we will make a little label for new sections similar to the one we are using for new language features and date them.

We’ll also put an overall “updated on date” on the page.

Yes, more specific documentation is planned.

The Primer is intended to be for SkookumScript the language and ideally game engine independent since SkookumScript can be used for any game engine.

Obviously, UE4 is the current big SkookumScript engine integration so it will have its own specific docs and tutorials, etc too.

If you haven’t already, look at the existing + docs:

Also these forum posts:

Workflow for instance-specific scripts

When designing the SkookumScript plugin we have decided to rely on the existing Blueprint class infrastructure to expose such editable variables to the designers. So let's say you wanted to use a component to implement this behavior as you suggested. In this case you would still create a Blueprint class to hold the variable even though you would not use its event graphs. Here is how you do it (you need to sync to latest from P4 before you can do this - I had to squeeze in a minor tweak): Create a new Blueprint class called PrintLocationComponentSk derived from SkookumScriptBehaviorComponent Add a variable named Timeout of type Float and make it public Compile it Click the Sk button in the Blueprint editor window of that component - this should open up the IDE and select the SkookumScript class PrintLocationComponentSk Using the Add a Class/Member dialog at the bottom of the member list, add a method on_begin_play (if this is the first time you are adding Sk code to the project, …

How to set up a UE4 C++ project to work with SkookumScript Unreal Engine 4 Plugin

Making your C++ project work with SkookumScript (i.e. how to use UCLASS, UFUNCTION. UPROPERTY and UENUM macros in your own C++ code and have the reflected types appear in SkookumScript) requires making a few modifications to some source and build files. Follow this guide and you should have it working in no time. Please download the FireBot sample project from our downloads page. It is an example C++ project that uses SkookumScript, and we will use it as a reference. Start by creating a new file named SkookumScript.ini in your project's Config folder. We recommend you copy it from the FireBot project and modify it. In SkookumScript.ini, you specify +ScriptSupportedModules to tell SkookumScript for which module to generate bindings (this is usually just one module - your main game module) +AdditionalIncludes to specify additional include files to include to make the binding code work (this is sometimes necessary as UE4 header files very often do not include all necessary sub-inclu…