slash commands question

[vsrs_au]

Are ESO addons allowed to run slash commands? Or is it prevented due to possible exploits?

[Vilkasmanga]

Not sure what you mean, can you elaborate?

Addons can add slash commands (like, enable additional functionality from the command line) and they can invoke a lot of the same (non-combat related) tasks as some of the existing slash commands...?

What did you have in mind?

-V

[vsrs_au]

Originally Posted by Vilkasmanga Not sure what you mean, can you elaborate? Addons can add slash commands (like, enable additional functionality from the command line) and they can invoke a lot of the same (non-combat related) tasks as some of the existing slash commands...? What did you have in mind? -V

I want to know if addons can invoke slash commands, i.e. the command itself, not the code it runs.

[Dolgubon]

Yes. Slash commands are stored in the SLASH_COMMANDS table as functions. Thus, you can call commands as you would any other other table stored in a function.e.g. /script SLASH_COMMANDS['/sit']()

There's no possible exploits, as far as I'm aware, and most slash commands are either emotes or commands created by addons anyway.

[vsrs_au]

Originally Posted by Dolgubon Yes. Slash commands are stored in the SLASH_COMMANDS table as functions. Thus, you can call commands as you would any other other table stored in a function.e.g. /script SLASH_COMMANDS['/sit']() There's no possible exploits, as far as I'm aware, and most slash commands are either emotes or commands created by addons anyway.

Fantastic! I wanted to be able to invoke emotes with a single keypress (e.g. it's very nice for role-playing), and I didn't realise I could just invoke the SLASH_COMMANDS table entry as a no-argument function.

[vsrs_au]

I can't get the keybind to invoke the slash command. I updated an existing addon I've been working on, as follows:

Added new file Bindings.xml:

<Bindings>
  <Layer name="Slash commands">
    <Category name="Slash commands category 1">
      <Action name="SLASH_SLEEP">
        <Down>MyAddon.RunSlashCommand("/sleep")</Down>
      </Action>
    </Category>
  </Layer>
</Bindings>

Then, in the Initialise() function of my addon, I added the line:

	ZO_CreateStringId("SI_BINDING_NAME_SLASH_SLEEP", "Run slash command: /sleep")

and added a new function:

function MyAddon.RunSlashCommand(argtext)
	SLASH_COMMANDS[argtext]()
end

I also added the new filename Bindings.xml to the MyAddon.txt file. I don't know what I'm doing wrong here. There's no error popups, but when I assign a key to my custom keybind (which I can see in the "Controls" page), then press it, nothing happens.

I tried replacing the line in the new function with

d("slash cmd: sleep")

and then with

SLASH_COMMANDS["/sleep"]()

but they don't run, either, so it seems the keybind isn't running anything, so I guess the link between the keybind and the function call is broken??

[vsrs_au]

I found a way to make it work. For some reason, changing the layer name to "General" makes the code work, so I can press a single key and my player does /sleep. What's even odder is that the fix I found comes from a 10-year old ESOUI thread, LOL!

https://www.esoui.com/forums/showthread.php?p=3978

Perhaps someone could explain (a) why the layer name affects the keybind-function link, and (b) whether I can get this working with my own custom layer name?

[votan]

It depends on which layers are currently active.

You should not use the name "General", but its translatable string identifier: SI_KEYBINDINGS_LAYER_GENERAL
For example:

<Bindings>
  <Layer name="SI_KEYBINDINGS_LAYER_GENERAL">
    <Category name="SI_KEYBINDINGS_CATEGORY_USER_INTERFACE">
      <Action name="POTIONMAKER">
        <Down>SLASH_COMMANDS["/potionmaker"]()</Down>
      </Action>
    </Category>
  </Layer>
</Bindings>

If you want to use your own layer name, you have to push and remove the layer depending on where and when your keybinds should be enabled.
For example:

local function stateChanged(oldState, newState)
    if newState == SCENE_SHOWN then
        PushActionLayerByName(layerName)
    elseif newState == SCENE_HIDING then
        RemoveActionLayerByName(layerName)
    end
end
HUD_SCENE:RegisterCallback("StateChange", stateChanged)

But I think the SI_KEYBINDINGS_LAYER_GENERAL layer is what you want to use anyway.

[Calamath]

Originally Posted by vsrs_au Perhaps someone could explain (a) why the layer name affects the keybind-function link, and (b) whether I can get this working with my own custom layer name?

The action layers are hierarchical, so if you define your own action layer, you must manage it in your add-on. The code you initially showed did not work because it lacked the processing for that. So you have to understand how ESOUI scenes work, design which scenes activate your own action layer, and manage it using the api mentioned by votan.

But what you want to do is quite simple, and it is safer to take advantage of the GENERAL action layer of the vanilla UI.

[vsrs_au]

Thanks for the useful replies! Sorry for the delay in my reply: I was sleeping, and it's 4:30am here, I'm getting ready for work.