tab completion
out of 3897 meta-documentation entries...Name | player receives commands |
Event Lines | player receives commands |
Triggers | when the list of available server commands is sent to the player for tab completion. |
Generated Examples | after player receives commands: |
Has Player | Always. - this adds switches 'flagged:<flag name>' + 'permission:<node>', in addition to the '<player>' link. |
Contexts | <context.commands> returns a ListTag of received commands.
|
Determine | ListTag to set the player's available commands. NOTE: It is not possible to add entries to the command list, only remove them. |
Group | Player |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/player/PlayerReceivesCommandsScriptEvent.java#L15 |
Name | tab complete |
Event Lines | tab complete |
Triggers | when a player or the console is sent a list of available tab completions. |
Generated Examples | after tab complete: |
Has Player | when the tab completion is done by a player. - this adds switches 'flagged:<flag name>' + 'permission:<node>', in addition to the '<player>' link. |
Switches | command:<command_name> to only process the event if the command matches the input name. |
Contexts | <context.buffer> returns the full raw command buffer.
<context.command> returns the command name.
<context.current_arg> returns the current argument for completion.
<context.completions> returns a list of available tab completions.
<context.server> returns true if the tab completion was triggered from the console.
|
Determine | ListTag to set the list of available tab completions. |
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Group | Server |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/server/TabCompleteScriptEvent.java#L18 |
Name | Command Script Containers |
Description | Command script containers allow you to register your own custom commands to the server.
This also allows the command to show up in the '/help' command, with some info on the command. Note that existing names or aliases from other plugins will be overridden. If you want to run a script at the same time as an existing command, see on command. The following is the format for the container. The required keys are 'name:', 'description:', 'usage:', and 'script:' All other keys can be excluded if unneeded. If you are not intentionally setting a specific value for the other keys, it is strongly recommended that you simply not include them at all. Please note that 'name:' is the true name of the command (written by users), and 'usage:' is for documentation in the '/help' command. These two options should almost always show the same name. Command scripts can be automatically disabled by adding "enabled: false" as a root key (supports any load-time-parseable tags).
|
Group | Script Container System |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/containers/core/CommandScriptContainer.java#L28 |
Name | add_tab_completions |
Object | PlayerTag |
Input | ListTag |
Description | Adds custom tab completions that will be suggested to the player when typing in chat.
Tab completions added by this mechanism can be removed using PlayerTag.remove_tab_completions. |
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperPlayerExtensions.java#L193 |
Name | remove_tab_completions |
Object | PlayerTag |
Input | ListTag |
Description | Removes custom tab completions added by PlayerTag.add_tab_completions. |
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperPlayerExtensions.java#L207 |
Name | <PlayerTag.tab_completions[<command>]> |
Returns | ListTag |
Description | Returns a list of all tab completions for the given plaintext of a command.
Input is formatted equivalent to if it were typed into a chat bar, minus the '/' slash at the start. Input must necessarily contain at least one space. For example: "<player.tab_completions[npc ]>" will return all /NPC sub command names available to the player. This is only compatible with commands registered in Spigot. Meaning in particular, vanilla commands are not recognized or supported. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2527 |