Component for triggering an action when the player collides

[oaklandgit]

Hi,

Wanted to share this in case it's useful for anyone. It took a while for me to work it out.

It's a component I call "triggerByKeyPress" you add to a game object that a player would interact with on keypress.
(the example below relies on two additional components, hoverText() and overlay() but I'm not including them here.)

Usage:

In this example I have a message "envelope" that the player is supposed to click to read:

k.add([
        k.sprite("envelope"),
        triggerByKeyPress({
            text: "[X] READ", // message telling the user what to press
            offset: k.vec2(2, -30), // the offset of the message from the object
            key: "x", // the key to press
            callback: () => {
                overlay(msg)    // what to do when the user clicks
            }
        })
    ]
}

The triggerByKeyPress component:

function triggerByKeyPress(config) {

    let hoveringOver = false // player over item?
    let toolTip // the tooltip
    let waitingForPress = () => {
        return false
    }

    return {

        id: "triggerByKeyPress",
        requires: ["area"],

        add() {

            // moved in
            this.onCollide("player", (p) => {
                if(!hoveringOver) {
                    hoveringOver = p

                    toolTip = hoverText(config.text, this.pos.add(config.offset))
                    
                    waitingForPress = k.keyPress(config.key, () => {
                        waitingForPress()
                        waitingForPress = () => {
                            return false
                        }
                        config.callback()
                        k.destroy(toolTip)
                    })

                }
            }) 

        },

        update() {

            // nothing to see here folks
            if (!hoveringOver) return

            // if was hovering over but moved out
            if (!this.isColliding(hoveringOver)) {
                hoveringOver = false
                waitingForPress()
                waitingForPress = () => {
                    return false
                }
                k.destroy(toolTip)
            }
            
        },

    }
}