Misc Documentation

Here you will find Misc Functions that you can use that are not all that important to the main functionality of Finity.

ChangeToggleKey

FinityWindow:ChangeToggleKey(KeyCdoe)

The KeyCodes are the names of the keys that are on your keyboard, If they are not typed correctly then it will still be applied but will not work. E.g:

ChangeToggleKey("e") -- This will set it to the letter e but it will not work when you press E as it is not typed correctly. Capitalise the e letter and it will work

Dont know what keycodes there are and the names for each one? Heres roblox's official documentation: https://create.roblox.com/docs/reference/engine/enums/KeyCode

KeyCode names are what is at the end of: Enum.KeyCode. The keycode name is accepted as an acceptable toggle but only when entered correctly (View the warn above for more understanding). You can enter the entire Enum.KeyCode.Keyname as it will strip the input of: Enum.KeyCode. Just make sure the key name is correct.

Debugging

finity:EnableDebugging(status) -- Status only excepts true or false

The status is a boolean value. This means it only accepts true or false, anything other than true or false will cause it to throw an error.

Redownload Assets

finity:RedownloadAssets() -- No checks for the downloaded and remaining assets for now.

Create

finity:Create(class, properties) -- Instance type, { Properties }

Creates new instances. This is used to create and set properties of newly created instances. You can edit the properties of the instance's name by doing : { Name = "Name" }, Every other valid property of the instance will work inside this without needing to define the instances variable constantly.

Importing Custom themes

finity:ImportCustomThemes("theme name") -- the name that the theme is called.

The theme name is taken/looked for from the custom themes lua file that can be found inside the FinityGUI folder in your workspace. You can download your own one using the function below.

Downloading Custom themes/Assets

finity:DownloadCustomAsset("link", "AssetName", IsCustomThemeFile: boolean)

You can download custom themes but wont be able to replace images within the gui apart for using it to interact with roblox instances. The only way it can currently interact with the Gui is by downloading a Custom theme file. (WILL OVERWRITE EXISTING THEMES.)

Change Background Image

finity:ChangeBackgroundImage("ImageID/Path", Transparnecy: number)

If the image you want to use is an roblox asset, Input the ID only (Thats all the function needs.). It will throw an error otherwise by default.

Thin Project

self2:EnableThinProject(Enable) -- true/false boolean.

This will allow you to use an legacy part of the Finity design which is the ThinProject setting. This like its name, will make your project "thinner".

This, Like toast notifications are finity window functions and can be used after making a gui.

Hub Mode

finity:EnableHubMode(Enable) -- Boolean

Hub mode allows for the developer of a hub to remove the potentially annoying credits print that Finity prints by default. It gives them the option to hide it or show it.

If the value parsed is not a Boolean type value it will send the credits by default and will print an error message.