imposter / vscode-lua-vu

This is a Visual Studio Code extension providing Venice Unleashed type information and intermediate code generation to make mod development less tedious.

Vua

This is a Visual Studio Code extension providing Venice Unleashed type information and intermediate code generation to make mod development less tedious. It utilizes Sumneko's Lua extension for VS Code and adds an additional parser to read documentation from user code and generate intermediate code files to help the IntelliSense engine work with how classes and functions are defined in VU.

Usage

• Install the extension (Currently only Windows is supported!)
• Find Vua Commands command menu and then download and build the project templates and VU doc types using the Download and Build Content command
• Create a new project by providing a name and a path using the Create New Project command
• Write your code and enjoy type information

Features

The following are the supported and planned features for this extension:

• Creating a new project
• Updating cached project templates and documentation
• Rebuilding intermediate code
• Support for all Venice Unleashed types defined in the documentation
  • Frostbite types
  • Shared libraries/types
  • Server libraries/types
  • Client libraries/types
• Support for generating type information for user code
• Documentation support

Examples

The following is the recommended code style for user-defined classes:

---This is a customized user type containing public fields name and position
---@class MyObject
---@field name string|nil
---@field position Vec3
MyObject = class('MyObject')

---Constructor which initializes the class instance
---@param name string|nil
---@param position Vec3
function MyObject:__init(name, position)
    self.name = name
    self.position = position
end

---Get object's string representation
---@return string @ Returns a string representation of the object
function MyObject:ToString()
    return self.name .. ' : ' .. self.position
end

...

local obj = MyObject('obj', Vec3(1.0, 2.0, 3.0))

Changelog

See changelog for more information.

Acknowledgements

Some people I want to thank for their hard work.

Venice Unleashed Developers:

• Orfeas "NoFaTe" Zafeiris
• Allen "kiwidog" Thomas
• Mats "Powback" Bakken

Contributors:

• FlashHit For actively doing research and contributing to this extension ♥

For libraries and technologies used by this extension:

• sumneko for vscode-lua
• ANTLR for ANTLR4

vscode-lua-vu's Issues

Hooks autocomplete miss parameters

What it gives:

What it requires:

Update existing project

Maybe it would be nice to update an project. this would basically just override the project.workspace and all .vscode/settings.

Most use just the mod folder instead of a workspace/project. So maybe even that should work. So it would create a project.workspace and all .vscode/settings. And then close the folder and open the project.

error when creating a new project

Solved by Download and Build the files.

Darwin (MacOS) support? :D

Would be nice :)

Use $APPDATA for library location

Instead of: c:/users/admin/appdata/roaming/ you can just do $APPDATA/.

Use generic annotation for GetSettings

Use —-@generics for ResourceManager:GetSettings(string: Setting)

So for example if I do local s_GameSettings = ResourceManager:GetSettings("GameSettings") it would automatically identify it as GameSettings

Integrate EmmyLua language server

https://github.com/Imposter/EmmyLua-LanguageServer

Compile error file names not shown

Errors when generating intermediate files do not include the file name, making tracing the issue down very difficult.

differ between integer & number

atm every int & float gets the type ---@type number.
It would be better to give int the type ---@type integer and float the type ---@type number. That way it's easier to know what vext is expecting.

Not recognizing vext types

In some cases it doesn’t know NetEvents, WebUI etc.

Update Lua Lexer/Parser to 5.4

VU has been updated to Lua 5.4, we need to update the lexer and parser.

Don’t create files multiple times

Instead of creating the fb files 3 times, just create them one time and use them for all 3 folders/workspaces.

Vua fails to download documentation

When downloading and building the documentation content Visual Studio Code returns the following error:

table classes cause errors

---@class Test
local Test = {}

This is causing an error.

Intermediate files still in old path

As others have observed, in v0.3.0 the intermediate files are still in the ext/component folders and not in the project root. This should not happen and needs to be investigated.

[bug] error when new project folder already exists

This error appears when creating a new project using vua when the project folder defined already exists even when empty.

Failed to execute action
ENOENT: no such file or directory, lstat
'C:\Users\*UserName*\AppData\Local\Programs\Microsoft VS Code\.git'

Error: ENOENT: no such file or directory, lstat
'C:\Users\*UserName*\AppData\Local\Programs\Microsoft VS Code\.git'

static members unknown

https://docs.veniceunleashed.net/vext/ref/shared/type/vec3/
If I use Vec3.zero for example it will be unknown.

SpatialEntity throwing error

ext\Shared\.vu\types\shared\type\SpatialEntity.lua

Support require __shared files

Vector types issue

Instead of just being a vector it should be also the type. ie:
SoundPatchAsset.outputNodes will only show it as a vector instead of vector|AudioGraphNodeData[]

Netsocket return type

Instead of:

---`SERVER/CLIENT`
---Attempts to read data from the socket. Returns the data and a status code. The length of the returned data will not necessarily be the same as the requested data length.
---@param length number @ The number of bytes to read.
---@return undefined
function NetSocket:Read(length) end

It should be:

---`SERVER/CLIENT`
---Attempts to read data from the socket. Returns the data and a status code. The length of the returned data will not necessarily be the same as the requested data length.
---@param length number @ The number of bytes to read.
---@return string
---@return integer
function NetSocket:Read(length) end

This way it returns both.

https://docs.veniceunleashed.net/vext/ref/shared/type/netsocket/#read

https://github.com/EmulatorNexus/VU-Docs/blob/master/types/shared/type/NetSocket.yaml

Also if there is some error or idk, it should maybe return any instead of undefined.

parser issue

---VEXT Shared ResourceManager:LoadBundles Hook
---@param p_HookCtx HookContext
---@param p_Bundles string[]
---@param p_Compartment ResourceCompartment
local s_LoadBundlesHook = Hooks:Install('ResourceManager:LoadBundles', 1, function(p_HookCtx, p_Bundles, p_Compartment)
	print("Compartment : " .. p_Compartment)

	for _, l_BundleName in pairs(p_Bundles) do
		print("Loaded bundle: " .. l_BundleName)
	end
end)

local s_LevelLoaded = false

local s_LevelLoadedEvent = Events:Subscribe('Level:Loaded', function(p_LevelName, p_GameMode)
	s_LevelLoaded = true
end)

local s_LevelDestroyedEvent = Events:Subscribe('Level:Destroy', function()
	s_LevelLoaded = false
end)

local s_PartitionLoadedEvent = Events:Subscribe('Partition:Loaded', function(p_Partition)
	if s_LevelLoaded then
		print(p_Partition.name)
	end
end)

This is causing an error:

Add the mod.json to the project

Atm the projects don’t include the mod.json. Would be cool to be able to edit it aswell.

ipairs does not give types to the loop variables

With pairs:

With ipairs:

You can see how s_TargetPosition and l_EnemySpawnPoint don't have the correct type if you use ipairs

Parser grammar incorrectly handles comments and base classes

The current grammar does not allow for specifying base classes in the doc comments. It also does not correctly handle single line comments.

The following would result in a syntax error

---@class MyClass:SomeBaseClass

The following would result in a syntax error due to being an "invalid" comment, even though it is perfectly valid.

-- [key] -> [value]

Ability to disable intermediate file generation

Add json class

json.decode and json.encode are missing

Code Snippets

Add support for code snippets for events and other common tasks.

Canceling new project creation isn't working

If you create a new project with vua it will ask for the mod name and then for the location/path. Then it says Enter to go on and ESC to abort/ cancel it, but it isn't working. If I press ESC it will still create the project. If I just minimize the window or whatever it will also create the project. So there is no way to cancel it.
The issue is that I have to enter the whole location address C:\Users\%User%\Documents\Battlefield 3\Server\Admin\Mods\<Your Mod Name>. So I would also suggest that the address that it is currently using is editable, so I don't have to write the whole path. Or at least let me minimize to copy the address from the window explorer.

Fix class usage

Atm you have to do: MyClass = class 'MyClass' instead of just class 'MyClass

[Req] Support events and hooks

Like this:
LuaLS/lua-language-server#865

using:
https://github.com/EmulatorNexus/VU-Docs/tree/master/types/shared/event
And:
https://github.com/EmulatorNexus/VU-Docs/tree/master/types/shared/hook

Note: these are just links to the shared events and hooks. There are client and server specific ones as well.

Add support for nestedArrays, nestedTables and operators

The VU-Docs have nestedArrays, nestedTables and operators which are not currently implemented (or figured out) for the EmmyLua equivalent in the meta files.

This is required to finish up most of the VEXT related stuff for the 1.0 release.

Doc strings for type specification are not parsed correctly

An error is thrown by the parser when parsing the following code:

---@class TestClass
---@field array_nestedArray vector|vector[]|DataContainer[][]
---@field array_nestedTable vector|table<integer, DataContainer>[]
---@field table_nestedTable table<integer, table<integer, DataContainer>>
---@field table_nestedArray table<integer, vector|DataContainer[]>
local TestClass = class('TestClass')

The issue seems to be with the definition of the expression expDoc. This may require revision to completely support vector/array and table types.

Unable to download content after VSCode update

It seems like a recent VSCode update broke the content downloader of Vua

I'm running on VSCode 1.66.1

DataContainer typeInfo duplicate bug

add callback info

instead of:

---`SERVER/CLIENT`
---@param callback function @ A callback in the form `function(entity: Entity, event: EntityEvent): bool`.
---@return number
function Entity:RegisterEventCallback(callback) end

it should be

---`SERVER/CLIENT`
---@param callback fun(entity:Entity, event:EntityEvent):boolean
---@return number
function Entity:RegisterEventCallback(callback) end

Something like that if it is possible.