manticoregamesinc/vscode-core

A Visual Studio Code extension that adds support for the Core Games Lua API to the Lua Language Server.

Core Lua API for VS Code

A Visual Studio Code extension that adds support for the Core Games Lua API to the Lua Language Server.

As of version 1.0.0, this extension uses Sumneko's Lua Language Server with auto-generated EmmyLua annotations. The file in this repo is actually generated by using the manticore branch of this fork.

The extension itself does not come with any options. If you want to alter its behavior you have to change it in the Lua Language Server extension that gets installed automatically.

If you have previously been using vscode-core together with the Lua Coder Assist extension, make sure to uninstall that for the best results.

Sumneko's Lua extension also comes with it's own "Diagnostics" feature, so if you have been using other extensions that use Luacheck and a .luacheckrc file, you might want to either disable those extensions or the "Diagnostics" feature in Sumneko's.

Known Issues

• There is currently no support for Core API operators.

Installation

• Go to the Visual Studio Code Marketplace and click the "Install" button, that's it!

Related Repositories

• platform-documentation - The Core Lua API documentation website.
• core-types-generator - Generates the core-games-api.def.lua file that contains the Core API EmmyLua annotations.

Contributing

This project welcomes contributions and suggestions.

Releases

The CI is generating a new release for every tag on this repository and pushes it to the VSC marketplace.

To generate a new release you:

• Increase the version in package.json according to SemVer.
• Run npm install && npm run build
• Commit the changes with the new version number as the commit note.
• Create a tag but don't push it yet with the same name as the version number.
• Run npm run changelog, amend the changes to the last commit, remove the tag on the old commit, add the same tag on the new amended one.
• Push the commit with tag.

Community Contributors

• @agincel
• @SargntSprinkles

License

Licensed under the MIT license.

vscode-core's Issues

Chat.sendMessageHook definition missing

Describe the bug
A clear and concise description of what the bug is.
The Chat.sendMessageHook:Connect gives an undefined error in the VSCode editor, while it is a valid Core API definition.

To Reproduce
Steps to reproduce the behavior:

N/A

Expected behavior
No error

Screenshots
If applicable, add screenshots to help explain your problem.

Versions:

• VSCode Version: 1.59.1
• OS Version: Windows 10 19043.1165

Additional context
Add any other context about the problem here.

Class member function overloads of VSCode auto-completion are not being handled correctly

Describe the bug
Class member function overloads of VSCode auto-completion are not being handled correctly.

For example

To Reproduce
Steps to reproduce the behavior:

1. Create a script and try to autocomplete

At the moment the definition of the overloads is in here and looks like this:

--- Sets the override Camera object for the Player.
--- @overload fun(camera: Camera, lerpTime: number)
--- @param camera Camera
function PlayerInstance:SetOverrideCamera(camera) end

The problem lies in @overload fun(camera: Camera, lerpTime: number) it is expecting a reference to the class itself

The suggested fix in this instance is to prepend self with the type of the class object to the overload.

Like:
@overload fun(self: Player, camera: Camera, lerpTime: number)

This seems to fix it for me.

Expected behavior
Expect to see all overloads correctly

Screenshots

Versions:

• VSCode Version: 1.68.1
• OS Version: N/A

variable script type

Issue:

Wrong type for the variable "script".
Exemple intellisense won't show some props script.context
It is set to it's parent type CoreObject instead of Script

Fix:

--- @type Script
script = nil

Here:

vscode-core/src/EmmyLua/core-games-api.def.lua

Line 5498 in cf20009

--- @type CoreObject

Test performed:

In core you can type:
print(script.type, script:IsA("CoreObject"))
then it return:

Script true