Commands and Permissions

All commands are easy to use and are fully documented in game. The full an up-to-date list of commands that are available in your version of HoloAPI can be seen via /holo help.

The following list will usually only apply to the latest release of HoloAPI.

---

Commands

Command	Permission	Action
/holo	holoapi.holo	Base HoloAPI command. All in-game methods for creating holographic displays can be found under this command. Entering this command by itself will provide version information for HoloAPI.
/holo help	holoapi.holo	Retrieve help for all HoloAPI commands.
/holo help <page>	holoapi.holo	See the help page of a certain number.
/holo help <command>	holoapi.holo	Retrieve help for a certain command.
/holo create	holoapi.holo.create	Create a holographic display. Lines can be entered one after each other. Once the command is entered, you will be prompted to enter the line content.
/holo create <world> <x> <y> <z> <content>	holoapi.holo.create	Create a holographic display. <content> defines the first line of the new hologram. Extra lines can be added using the /holo addline <id> <content> command.
/holo create image <image_id>	holoapi.holo.create	Create a hologram based on an image. See the Configuration Wiki page for info on how to set up images.
/holo create image <image_id> <world> <x> <y> <z>	holoapi.holo.create	Create a hologram based on an image. See the Configuration Wiki page for info on how to set up images.
/holo create animation	holoapi.holo.create	Create an animated holographic display from lines of text.
/holo create animation <animation_id>	holoapi.holo.create	Create an animated hologram. See the Configuration Wiki page for info on how to set up GIFs.
/holo create animation <animation_id> <world> <x> <y> <z>	holoapi.holo.create	Create an animated hologram. See the Configuration Wiki page for info on how to set up GIFs.
/holo remove <hologram_id>	holoapi.holo.remove	Remove an active hologram using its assigned ID
/holo addline <id>	holoapi.holo.addline	Add a new line to an existing hologram. New line content can be more than one word. The user will be prompted for the content after the command is entered.
/holo addline <id> <content>	holoapi.holo.addline	Add a new line to an existing hologram. New line content can be more than one word.
/holo edit <id> <line>	holoapi.holo.edit	Edit a line of an existing hologram.
/holo edit <id> <line> <content>	holoapi.holo.edit	Edit a line of an existing hologram. The content can be more than one line.
/holo info	holoapi.holo.info	View information on all active holograms. Also useful for determining IDs
/holo nearby <radius>	holoapi.holo.nearby	View information on all nearby holograms within the specified radius
/holo move <id>	holoapi.holo.move	Move a hologram to your current position
/holo move <id> <world> <x> <y> <z>	holoapi.holo.move	Move a hologram to a new position
/holo teleport <id>	holoapi.holo.teleport	Teleport to a specific hologram.
/holo copy <id>	holoapi.holo.copy	Copy an existing hologram to your current position.
/holo copy <id> <world> <x> <y> <z>	holoapi.holo.copy	Copy an existing hologram to a new position.
/holo id set <old_id> <new_id>	holoapi.holo.id	Set the save ID of an existing hologram. Save IDs are used to identify holograms and are used in the HoloAPI save files.
/holo show <id> <player>	holoapi.holo.show	Show a hologram to a player.
/holo hide <id> <player>	holoapi.holo.hide	Hide a hologram from a player.
/holo touch add <id> <command>	holoapi.holo.touch.add	Add an action for a certain hologram to perform when touched. Actions defined without the use of the API (through this command) may only be commands. The %name% placeholder can be used to define the user that touched the hologram. Commands can be more than one word.
/holo touch add <id> <as_console> <command>	holoapi.holo.touch.add	Same functionality as /holo touch add <command>. <as_console> defines whether the action is performed by the console or the player that touched the hologram. HoloAPI will detect if <as_console> is a true or false value.
/holo touch remove <id> <touch_id>	holoapi.holo.touch.remove	Remove an action for a TouchScreen hologram, where <touch_id> is the ID of the TouchAction. To remove a command-based Touch Action, simply enter the command"
/holo touch clear <id>	holoapi.holo.touch.clear	Clear all Touch Actions for a particular TouchScreen hologram
/holo touch info <id>	holoapi.holo.touch.info	View information on all Touch Actions for a particular TouchScreen hologram
/holo visibility <id>	holoapi.holo.visibility	View the visibility of a particular hologram.
/holo visibility <id> <type>	holoapi.holo.visibility	Set the visibility of a particular hologram. Valid types for HoloAPI are: all, permission. Visibility types dynamically registered using the Visibility API may be defined using this command.
/holo build	holoapi.holo.build	Dynamically build a combined hologram of both text and images.
/holo readtxt <url>	holoapi.holo.readtxt	Creates a hologram from a given URL.
/holo refresh <id>	holoapi.holo.refresh	Refresh a Hologram of the specified ID.
/holo reload	holoapi.holo.reload	Reload all configuration files and holograms
/holo update	holoapi.update	Update HoloAPI if a new version has been found.

For more information regarding TouchScreen holograms, see this page.

---

Permissions

Permission	Description
holoapi.holo	Required to use ALL HoloAPI commands.
holoapi.holo.create	Required for all commands under /holo create
holoapi.holo.remove	Required for all commands under /holo remove
holoapi.holo.addline	Required for all commands under /holo addline
holoapi.holo.edit	Required for all commands under /holo edit
holoapi.holo.info	Required for all commands under /holo info
holoapi.holo.nearby	Required for all commands under /holo nearby
holoapi.holo.move	Required for all commands under /holo move
holoapi.holo.teleport	Required for all commands under /holo teleport
holoapi.holo.copy	Required for all commands under /holo copy
holoapi.holo.id	Required for all commands under /holo id
holoapi.holo.show	Required for all commands under /holo show
holoapi.holo.hide	Required for all commands under /holo hide
holoapi.holo.build	Required for all commands under /holo build
holoapi.holo.touch.add	Required for all commands under /holo touch add
holoapi.holo.touch.remove	Required for all commands under /holo touch remove
holoapi.holo.touch.clear	Required for all commands under /holo touch clear
holoapi.holo.touch.info	Required for all commands under /holo touch info
holoapi.holo.visibility	Required for all commands under /holo visibility
holoapi.holo.readtxt	Required for all commands under /holo readtxt
holoapi.holo.refresh	Required for all commands under /holo refresh
holoapi.holo.reload	Required for all commands under /holo reload
holoapi.update	Required to update the plugin from in-game (/holo update)

Group Nodes

Permission	Description
holoapi.*	Gives access to ALL permission nodes.
holoapi.holo.touch.*	Gives access to ALL TouchScreen commands.

Visibility Permissions

When the visibility of a hologram is set to PERMISSION, the following permission nodes define who can see that hologram.

Normal holograms are not affected and can be seen by all players. Using /holo visibility <id> <type> changes a hologram's visibility.

Permission	Description
holoapi.see.all	Allows a player to see ALL holograms set in this mode.
holoapi.holo.see.<hologram_id>	Allows a player to see a specific hologram if it is in this mode.