Custom Holograms
  • Introduction
    • Commands & Permissions
      • Create
      • Delete
      • Rename
      • Set Line
      • Insert Line
      • Add Line
      • Remove Line
      • Teleport Here
      • Align
      • Move
      • Boldness
      • Load
      • Unload
      • Load All
      • Unload All
      • Disable Script
      • List
      • Teleport To
      • Info
      • Reload
      • Docs
      • Support
  • Getting Started
    • Creating Holograms
    • Deleting Holograms
    • Editing Lines
    • Editing Holograms
  • API
    • Helper Functions
      • Holograms_ReplaceEmptyValues()
      • Skent_getRawNames()
    • Hologram Functions
      • Holograms_TeleportPlayerTo()
      • Holograms_TeleportHere()
      • Holograms_Create()
      • Holograms_Delete()
      • Holograms_SetLine()
      • Holograms_InsertLine()
      • Holograms_AddLine()
      • Holograms_RemoveLine()
      • Holograms_LoadAll()
      • Holograms_UnloadAll()
      • Holograms_ListAll()
      • Holograms_ListLoaded()
      • Holograms_ListUnloaded()
      • Holograms_GetAll()
      • Holograms_GetLoaded()
      • Holograms_GetUnloaded()
      • Holograms_Load()
      • Holograms_Unload()
      • Holograms_Info()
      • Holograms_Align()
      • Holograms_Move()
      • Holograms_Rename()
      • Holograms_SetBoldness()
      • Holograms_GetLines()
Powered by GitBook
On this page
  • Full Function
  • Parameters
  • Return Values & Meanings
  • Usage
  1. API
  2. Hologram Functions

Holograms_Unload()

Unload a hologram

Full Function

Holograms_Unload(id: string, unload: boolean = true)

Parameters

Name
Type
Description

id

text/string

ID of hologram

unload

boolean

Option to unload the YAML file. This parameter is optional Default is true. If you set this to false, the YAML file will not be unloaded from the server's memory.

Return Values & Meanings

Success

Error - Hologram does not exist

Usage

set {_unload} to Holograms_Unload("hologram_id")
if {_unload} is false:
    send "That hologram does not exist!"
PreviousHolograms_Load()NextHolograms_Info()

Last updated 2 years ago