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

find_feature(name : string): types.neon_feature ​

Finds a feature by name

  • name (string) The name of the feature
  • returns (types.neon_feature) The feature object or nil if not found

features_list(): table ​

Returns all features as a list of types.neon_feature objects

  • returns (table) The features

execute_dot_command(cmd : string) ​

Executes a Neon dot command

  • cmd (string) The full command string without leading dot

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

is_bot_entity(entity : userdata): boolean ​

Returns whether an entity is marked as a bot by the 'Anti Bot' feature or not

  • entity (userdata) The entity to check against.
  • returns (boolean) The entity bot status

is_friend_entity(entity : userdata): boolean ​

Returns whether an entity is marked as a friend or not

  • entity (userdata) The entity to check against.
  • returns (boolean) The entity friend status

get_neon_username(entity : userdata): string ​

Returns the Neon username of the given entity if they are a Neon user

  • entity (userdata) The entity to check against.
  • returns (string) The Neon username or nil if not found

send_notification(title : string, message : string, type : enums.notification_type, duration : number) ​

Sends a notification to the user

  • title (string) The title of the notification
  • message (string) The message of the notification
  • type (enums.notification_type) The type of the notification
  • duration (number) The duration in seconds