Skip to content

AtlasFw/vsc-atl

Repository files navigation

Atlas Framework Snippets

Official Atlas Framework Snippets created by Atlas Development Team.

Introduction

All official snippets related to Atlas Framework. This includes the core and all other Atlas resources. This extension will be constantly updated by adding new core functions, events, and more. Don't forget that you can give us a hand in the official GitHub Repository or by writing a review.

Installation

This VS Code extension adds snippets from atl-core and other resources which have usable functions. You can easily download it by searching "Atlas Framework" on the extensions tab or by installing it from the marketplace.

Documentation

If you need further help, you can take a look at our awesome documentation made with docsify.

How to Use

Currently, we only have Lua support which includes both client and server functions with an additional support for importing from your fxmanifest. To start, just type ATL or even the name of the function such as RemoveAccountMoney or ATL.RemoveAccountMoney (these also autocomplete). Once you are hovering over your desired function, you can press Tab to autocomplete the function. You will see that your caret is now on one of the parameters, you can press Tab again to move to the next one. This can be done with all the parameters and will only be canceled if you select something else with your mouse cursor.

Player methods have player instead of ATL. This is because you require the player in order to execute the methods. You can use ATL.GetPlayer(player) to get the player object.

--Both lines are provided by extension.
local player = ATL.GetPlayer(player)
player.getSlots()

Issues

Any issues regarding snippets or missing arguments are to be reported on GitHub Issues.