Skip to main content

Guide

Contains functions for interacting with the interactive Guide system.

info

This module can only be used in Entity scripts.

Properties

isCodeEditorOpen

Returns true if the Lua Editor is open. This property is read-only.

Functions

hack(entity, moduleFilter)

Opens the Lua Editor to edit the script assigned to the specified Entity.

Parameters

  • entity The Entity to hack.
  • moduleFilter An optional list of modules the entity is permitted to use. If not specified, the entity will be able to use all modules.

resetHack(entity)

Resets the Lua Editor to the original script assigned to the specified Entity.

Parameters

  • entity The Entity to reset.

hasModifiedScript(entity)

Returns true if the target entity's script has changed. Only returns true in Solo worlds.

Parameters