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_Load()

Remove a line from a hologram

Full Function

Holograms_Load(id: string)

Parameters

Name
Type
Description

id

text/string

ID of hologram

forceLoad

boolean

This parameter is optional. If this parameter is not set and the hologram is in an unloaded chunk, the hologram will not load. If this parameter is set to true, the chunk will be force loaded, and the hologram will load as normal. Default: false

Return Values & Meanings

Success

Error - Chunk at hologram is not loaded

Error - Hologram does not exist

Usage

set {_load} to Holograms_Load("hologram_id")
if {_load} is 1:
    send "The chunk the hologram is in is not loaded!"
    send "Set the second parameter to 'true' to avoid this!"

Holograms_Load("hologram_id", true)
PreviousHolograms_GetUnloaded()NextHolograms_Unload()

Last updated 2 years ago