Neon Scripting API

Appearance

neon ​

Utilities to interact with Neon

Functions ​

username(): string ​

Returns the current Neon username

  • returns (string)

version(): string ​

Returns the current Neon version

  • returns (string)

register_feature(name : string, desc : string): types.feature ​

Registers a feature in the client

  • name (string) The name of the feature
  • desc (string) The description of the feature
  • returns (types.feature) The registered feature

register_command(name : string, desc : string, opt_aliases : table, opt_args : table, opt_executor : function) ​

Registers a command in the client

  • name (string) The name of the command
  • desc (string) The description of the command
  • opt_aliases (table) (optional) The aliases for the command
  • opt_args (table) (optional) The arguments for the command
  • opt_executor (function) (optional) The command executor function

is_feature_enabled(name : string): bool ​

Returns whether a feature is enabled or not

  • name (string) The name of the feature
  • returns (bool) The feature state

toggle_feature(name : string) ​

Toggles a feature

  • name (string) The name of the feature

features_list(): table ​

Returns all feature names as a list of strings

  • returns (table) The feature names

execute_command(cmd : string) ​

Executes a chat command

  • cmd (string) The full command string

killaura_target(): userdata ​

Gets the current killaura target

  • returns (userdata) (Minecraft's Java LivingEntity object)

first_theme_color(): types.color ​

Gets the first color gradient of the currently set theme

second_theme_color(): types.color ​

Gets the second color gradient of the currently set theme