Core Games API - Unofficial Lua Types

WIP Disclaimer

This project is still a work in progress and need some improvements :

• Use the CoreGameAPI.json file
• Change output file core-games-api.def.lua (currently using the one on Github)
• Implements global script (not defined in CoreGameAPI)
• Generate file structure with full implementation
  • Namespaces
  • Classes
  • Enums
  • Inheritance
• Better Event Type with use of Generics
• Optional function parameters
• Create daily release system
• Provide a better documentation
• Improve code structure

Why ?

When working on Lua with Core Games, even with the referenced plugins for VSCode it does not provide a good type checking. Type checking provide a good flexible autocomplete system and give you errors when you are trying to access undefined properties.

Without Types

With Types

Install

As the types are just from a simple Lua file it can be understand in any IDE, VSCode, Jetbrains, etc. I still encourage to use Intellij IDEA, it provides stronger understanding of types.

VSCode

1. Install EmmyLua

In order to enjoy the power of LDoc you must use a plugin that understand it. The plugins advised by Core Games do not provide this feature, you should uninstall them before :

• VSCode-Lua
• Lua Coder Assist
• VSCode-Core

Then install the EmmyLua plugin for VSCode

2. Install Java 8+

EmmyLua need Java 8+ to work, you can download it here: [Java 8+]

3. Add JAVA_HOME environment variable

Once Java is installed, you have to tell to EmmyLua where it is.

• Windows
  • In the searchbar, type : 'Environment Variables'
  • Click on 'Environment Variables...'
  • Click on 'New'
  • In the name field type JAVA_HOME
  • In the value field, local the folder of the Java Directory, it should look like this C:\Program Files\Java\jre1.8.0_291

4. Open your project with VSCode

First, you must retrieve the location of your project. For that Right Click on a script in the Core Editor Project Content, click on Show in explorer and copy the link of the directory.

Then open VSCode and click on File > Open Folder... and paste the path of your scripts folder.

5. Add the definition file to your project

In Core Editor, create a new Script called CoreGamesAPI and delete it from the hierarchy. Open the Script in VSCode and paste the content of core-games-api.def.lua in it.

Done! You can now code and have full autocomplete for the CoreGamesAPI and also for your own Scripts!

The plugin VSCode-EmmyLua does not support @alias tags, you will still have errors with Enums.

IntelliJ IDEA (or PhpStorm, Webstorm, etc)

1. Install EmmyLua

In order to enjoy the power of LDoc you must use a plugin that understand it.

For that, install the Luanalysis plugin for Jetbrains

2. Open your project with Jetbrains

First, you must retrieve the location of your project. For that Right Click on a script in the Core Editor Project Content, click on Show in explorer and copy the link of the directory.

Then open Jetbrains and click on File > Open... and paste the path of your scripts folder.

3. Add the definition file to your project

In Core Editor, create a new Script called CoreGamesAPI and delete it from the hierarchy. Open the Script in VSCode and paste the content of core-games-api.def.lua in it.

Done! You can now code and have full autocomplete for the CoreGamesAPI and also for your own Scripts!

How

Whenever you code, typing what you write is always a good thing. For you, and for the others.

Functions

By typing your function parameters, you will be able to have full autocompletion inside your functions. And by typing the return, you will be able to call this function anywhere in your application and still enjoying the autocomplete and the type checking.

--- @param player Player
--- @return number
function GetMoney(player)
    return player:GetResource("money")
end

Locals

By typing your locals you will be able to enjoy autocomplete and type checking even on your custom properties !

--- @type number
local customProperty = script.parent:GetCustomProperty("customProperty")

--- @type ScriptAsset
local myScript = script.parent:GetCustomProperty("myScript")

Classes

You create your own types by adding LDoc to your classes.

--- @class MyClass
MyClass = {}

return MyClass

Now you can use this type to enjoy autocompletion on your own modules.

local propMyScript = script.parent:GetCustomProperty("myScript")

--- @type MyClass
local MyClass = require(propMyScript)