-----------------------------------
-- func: menu
-- desc: Shows a basic test menu with three options
-- note: title and options are required.
--     : onStart, onCancelled, and onEnd are optional.
--     : You must provide at least one option.
--     : Incorrectly creating or configuring a menu
--     : will not result in a crash or broken menus,
--     : but will produce scary looking warnings in
--     : the log.
-----------------------------------
---@type TCommand
local commandObj = {}

commandObj.cmdprops =
{
    permission = 1,
    parameters = ''
}

commandObj.onTrigger = function(player)
    local menu =
    {
        title   = 'Test Menu (Play Effect)',
        onStart = function(playerArg)
            -- NOTE: This could be used to lock the player in place
            playerArg:printToPlayer('Test Menu Opening', xi.msg.channel.NS_SAY)
        end,

        options =
        {
            {
                'Option 1: Hearts',
                function(playerArg)
                    playerArg:printToPlayer('Option 1 Selected', xi.msg.channel.NS_SAY)
                    playerArg:independentAnimation(playerArg, 251, 4) -- Hearts
                end,
            },
            {
                'Option 2: Music Notes',
                function(playerArg)
                    playerArg:printToPlayer('Option 2 Selected', xi.msg.channel.NS_SAY)
                    playerArg:independentAnimation(playerArg, 252, 4) -- Music Notes
                end,
            },
            {
                'Option 3: Lightbulb',
                function(playerArg)
                    playerArg:printToPlayer('Option 3 Selected', xi.msg.channel.NS_SAY)
                    playerArg:independentAnimation(playerArg, 250, 4) -- Lightbulb
                end,
            },
        },

        onCancelled = function(playerArg)
            playerArg:printToPlayer('Test Menu Cancelled', xi.msg.channel.NS_SAY)
        end,

        onEnd = function(playerArg)
            -- NOTE: This could be used to release a locked player,
            playerArg:printToPlayer('Test Menu Closing', xi.msg.channel.NS_SAY)
        end,
    }
    player:customMenu(menu)
end

return commandObj