That sounds silly, I know. What's the best way to debug confirm something didn't go wrong with regis - League of Extraordinary FoundryVTT Developers

Ccorporat That sounds silly, I know. What's the best way to debug confirm something didn't...

C

Calego•5/8/21, 3:00 PM

You can usually do something like add in a console log or debugger in your hook callback to see if it's being fired.

Core will log which hooks should be fired even if there are no registered callbacks when you have the hooks debugging on

C

corporatOP•5/8/21, 3:00 PM

yeah I tried that and got nothing

C

Calego•5/8/21, 3:01 PM

First thing to check is spelling, after that, where are you registering the hook?

CCalego You can usually do something like add in a console log or debugger in your hook ...

Z

zeel•5/8/21, 3:01 PM

I don't think Core logs unregistered Hooks.

C

corporatOP•5/8/21, 3:02 PM

Hooks.on("renderPlayerList", onRenderPlayerList);

Hooks.on("renderPlayerList", onRenderPlayerList);

Hooks.on("renderPlayerList", onRenderPlayerList);

Hooks.on("renderPlayerList", onRenderPlayerList);

Z

zeel•5/8/21, 3:02 PM

I could swear that was one of the problems with relying on the debug mode, that there were Hooks it never logged.

C

corporatOP•5/8/21, 3:03 PM

const onRenderPlayerList = (_playerList, html) => {

const onRenderPlayerList = (_playerList, html) => {

const onRenderPlayerList = (_playerList, html) => {

const onRenderPlayerList = (_playerList, html) => {

Zzeel I could swear that was one of the problems with relying on the debug mode, that ...

C

Calego•5/8/21, 3:03 PM

I'm pretty sure the opposite but now I'm doubting myself

C

corporatOP•5/8/21, 3:04 PM

it's very possible I'm not receiving what I want out of html

Ccorporat `Hooks.on("renderPlayerList", onRenderPlayerList);`

C

Calego•5/8/21, 3:04 PM

This isn't inside a function that's only called sometimes right?

Ccorporat `Hooks.on("renderPlayerList", onRenderPlayerList);`

Z

zeel•5/8/21, 3:04 PM

Try using

console.warn

console.warn

console.warn

console.warn as the hook function.

Z

zeel•5/8/21, 3:05 PM

To test it, it should spit out all the arguments, and it will be easier to find in the console.

CCalego This isn't inside a function that's only called sometimes right?

C

corporatOP•5/8/21, 3:12 PM

Shouldn't be!

Zzeel Try using `console.warn` as the hook function.

C

corporatOP•5/8/21, 3:12 PM

That didn't work

C

corporatOP•5/8/21, 3:14 PM

It makes sense if core suppresses(?) hook logs. I feel like that's something I've run into before

Z

zeel•5/8/21, 3:14 PM

If that doesn't work, I don't think thr hook is getting called.

Z

zeel•5/8/21, 3:14 PM

Lemme see if I can repro.

C

corporatOP•5/8/21, 3:16 PM

oh shit this might be a gulp issue?

Z

zeel•5/8/21, 3:17 PM

?

C

corporatOP•5/8/21, 3:17 PM

one of my js files isn't getting emitted from the new ts

Z

zeel•5/8/21, 3:17 PM

(You on 0.7 or 0.8?)

C

corporatOP•5/8/21, 3:17 PM

the one that registers hooks

C

corporatOP•5/8/21, 3:17 PM

0.8

Z

zeel•5/8/21, 3:18 PM

Try registering the hook in the console.

C

corporatOP•5/8/21, 3:18 PM

yeah fuck gulp lol

C

Calego•5/8/21, 3:19 PM

oh yep that'll do it

CCalego I'm pretty sure the opposite but now I'm doubting myself

Z

zeel•5/8/21, 3:22 PM

  static call(hook, ...args) {
    if ( CONFIG.debug.hooks ) {
      console.log(`DEBUG | Calling ${hook} hook with args:`);
      console.log(args);
    }
    if ( !this._hooks.hasOwnProperty(hook) ) return;
    const fns = new Array(...this._hooks[hook]);
    for ( let fn of fns ) {
      let callAdditional = this._call(hook, fn, args);
      if ( callAdditional === false ) return false;
    }
    return true;
  }

  static call(hook, ...args) {
    if ( CONFIG.debug.hooks ) {
      console.log(`DEBUG | Calling ${hook} hook with args:`);
      console.log(args);
    }
    if ( !this._hooks.hasOwnProperty(hook) ) return;
    const fns = new Array(...this._hooks[hook]);
    for ( let fn of fns ) {
      let callAdditional = this._call(hook, fn, args);
      if ( callAdditional === false ) return false;
    }
    return true;
  }

  static call(hook, ...args) {
    if ( CONFIG.debug.hooks ) {
      console.log(`DEBUG | Calling ${hook} hook with args:`);
      console.log(args);
    }
    if ( !this._hooks.hasOwnProperty(hook) ) return;
    const fns = new Array(...this._hooks[hook]);
    for ( let fn of fns ) {
      let callAdditional = this._call(hook, fn, args);
      if ( callAdditional === false ) return false;
    }
    return true;
  }

  static call(hook, ...args) {
    if ( CONFIG.debug.hooks ) {
      console.log(`DEBUG | Calling ${hook} hook with args:`);
      console.log(args);
    }
    if ( !this._hooks.hasOwnProperty(hook) ) return;
    const fns = new Array(...this._hooks[hook]);
    for ( let fn of fns ) {
      let callAdditional = this._call(hook, fn, args);
      if ( callAdditional === false ) return false;
    }
    return true;
  }

Z

zeel•5/8/21, 3:22 PM

Looks like the logging is the first thing it does, so that should log any hook that is

call

call

call

called.

Z

zeel•5/8/21, 3:23 PM

But I could swear there was an issue of the opposite being true.

Z

zeel•5/8/21, 3:23 PM

But it's possible that was in the past.,

NNecrophage How do I add a button to the game field that will toggle open/close a applicatio...

C

Calego•5/8/21, 9:57 PM

This is a pretty open ended question but I'll try to overview what you're after:

First you're going to need a Hook which you can tap into to inject an element onto the page. A good candidates is "ready".

Then you'll need to actually inject your element, imo a button is best, and register a listener to control the interaction. With jquery something like this:

$(".my-button").on("click", () => doSomething())

$(".my-button").on("click", () => doSomething())

$(".my-button").on("click", () => doSomething())

$(".my-button").on("click", () => doSomething())

The last step is going to be actually doing something. You'll need to keep a reference to whatever Application you want to open and close somewhere that the listener code can use it.

NNecrophage How do I add a button to the game field that will toggle open/close a applicatio...

B

BadIdeasBureau•5/8/21, 9:57 PM

Here's some example code for how I add a button to the tiles control list in one of my projects:

Hooks.on("getSceneControlButtons", addFlattenerButton); //add the button for this to the menu

function addFlattenerButton(buttons) {
    let tilesButton = buttons.find(b => b.name == "tiles")
    if (tilesButton) {
        tilesButton.tools.push({
            name: "request-roll",
            title: game.i18n.localize('TILE-FLATTENER.Button'),
            icon: "fas fa-layer-group",
            visible: game.user.isGM,
            onClick: () => flattenTilePrompt(),
                        button: true
        });
    }
};

Hooks.on("getSceneControlButtons", addFlattenerButton); //add the button for this to the menu

function addFlattenerButton(buttons) {
    let tilesButton = buttons.find(b => b.name == "tiles")
    if (tilesButton) {
        tilesButton.tools.push({
            name: "request-roll",
            title: game.i18n.localize('TILE-FLATTENER.Button'),
            icon: "fas fa-layer-group",
            visible: game.user.isGM,
            onClick: () => flattenTilePrompt(),
                        button: true
        });
    }
};

Hooks.on("getSceneControlButtons", addFlattenerButton); //add the button for this to the menu

function addFlattenerButton(buttons) {
    let tilesButton = buttons.find(b => b.name == "tiles")
    if (tilesButton) {
        tilesButton.tools.push({
            name: "request-roll",
            title: game.i18n.localize('TILE-FLATTENER.Button'),
            icon: "fas fa-layer-group",
            visible: game.user.isGM,
            onClick: () => flattenTilePrompt(),
                        button: true
        });
    }
};

Hooks.on("getSceneControlButtons", addFlattenerButton); //add the button for this to the menu

function addFlattenerButton(buttons) {
    let tilesButton = buttons.find(b => b.name == "tiles")
    if (tilesButton) {
        tilesButton.tools.push({
            name: "request-roll",
            title: game.i18n.localize('TILE-FLATTENER.Button'),
            icon: "fas fa-layer-group",
            visible: game.user.isGM,
            onClick: () => flattenTilePrompt(),
                        button: true
        });
    }
};

(the button calls

flattenTilePrompt()

flattenTilePrompt()

flattenTilePrompt()

flattenTilePrompt() when clicked).

Hooking on "getSceneControlButtons" and then adding your button to where you want it in the argument that hook gives you is the way to do this.

Toggling an application on and off is doable - you would want a function which:
if the application is not open, creates it and renders it.
If the application is open, finds it and calls the .close() method to close it (with enough checks to make sure you're actually closing the application you care about)

C

Calego•5/8/21, 9:57 PM

I'll leave you with @badideasbureau ;)

B

BadIdeasBureau•5/8/21, 9:58 PM

(mine is if you want it in the scene control buttons. Calego's is more general if you want a button somewhere else on the screen, e.g. in the chat pane)

C

Calego•5/8/21, 9:59 PM

Right, that's a good point to make a distinction of

B

BadIdeasBureau•5/8/21, 10:04 PM

OK, so do you roughly understand what the code I posted above is doing, or do you want me to explain it in a bit more detail?

B

BadIdeasBureau•5/8/21, 10:07 PM

Alright. I'm pretty much the other way around (I'm reasonably familiar with the Foundry API at this point, but my js fundamentals are shonky), so sorry if I end up explaining something JS standard as if it's a new thing

B

BadIdeasBureau•5/8/21, 10:11 PM

OK, so, Foundry communicates between a lot of its parts with hooks. The way to access these is

Hooks.on("hookName", callback)

Hooks.on("hookName", callback)

Hooks.on("hookName", callback)

Hooks.on("hookName", callback), which will call

callback

callback

callback

callback whenever the hookName hook is thrown out by part of the code. The hook will pass arguments, which are generally used to go "hey, I'm doing this, and this is the data I'm doing it with".

A fairly common approach for hooks in Foundry is for the hook to pass an argument which is the thing being created by the function that throws the hook, and allow the callback functions to modify that argument. This is what's happening here - the "getSceneControlButtons" hook passes an argument of

buttons

buttons

buttons

buttons, which is an array of each of the scene tools.

B

BadIdeasBureau•5/8/21, 10:12 PM

So what my code is doing is a) checking that the "tiles" tool group exists (in case a module has screwed with it), and then if it does it pushes a new button into its tools array, with an onClick callback to do what I want it to do.