If you need help, join the Discord!

What is this?

This is a tool that allows you to create and customize an in-game cursor-based user interface. By using the player's facing angles, the script simulates a cursor that can interact with buttons on the screen.

What's the difference between this and Josbird's Cursor Menu?

I'd define this as a "trimmed down" and modernized version of JCM. Since Josbird is not currently working on it, it doesn't make use of some workshop features introduced after it was released. See some of the basic differences:

Why is it in beta?

The tool is complete and functional. However, it is in its first rendition and still pretty much untested in real modes, so I want to make sure that it works as intended for most use cases before calling it 1.0. Any feedback is valuable!

How To Use

1. Import the code J9FWD into your lobby;
2. Mess around with the demo (Optional);
3. Open the workshop script editor and copy the rules as indicated;
4. Go back to your mode and paste those rules (preferably to the bottom to ensure compatibility);
5. Read the rest of this page to know how to configure your buttons!

Creating Buttons

In this tool, a button is represented as an array of data stored within the cm_Buttons global variable. To add a button, you populate an array with values and assign it to a specific index of the global variable. In simpler terms, the first button's data is stored in cm_Buttons[0], the second in cm_Buttons[1], and so forth.

To see an example, import the code and navigate to the [CM] Add Buttons ★ rule. There, you'll observe two demo buttons configured as Global.cm_Buttons[0] and Global.cm_Buttons[1] respectively.

Each index of the array contains a property for the button. See how they're organised in the table below:

Button Coordinate Map (X, Y)

Updating Buttons Mid-Game

Once a player joins, the contents of the cm_Buttons global variable are copied into the player's cm_ButtonsPlayer variable. This allows you to change each of the button's properties for each player without interference.

To do that, you have re-set the entire button array inside cm_ButtonsPlayer at the corresponding index, as if you were creating the button for the first time. For example: to update a button pertaining to index 3 of cm_ButtonsPlayer, you'd use the action cm_ButtonsPlayer[3] = Array(New Properties). Due to workshop limitations, you can't change individual properties directly.

You can not delete buttons or create new ones mid-game, only change their properties.

Pages

Pages are quite simple. The player's current page is defined by the cm_CurrentPage player variable. Buttons that have their page set to a value will only be visible and clickable when cm_CurrentPage is that value. Buttons with page zero/null are active in all pages.

Triggers

When a button is being hovered on by the cursor, the cm_CurrentHover player variable will be equal to the ID you assigned the button. Use this to program the desired behavior for hovering over the button, if any.

When a button is clicked using Primary Fire (M1, R2, RT) or Jump (Spacbar, X, A), the cm_CurrentClick player variable will be equal to the ID you assigned the button until the button is no longer held. If it is clicked using Secondary Fire (M2, L2, LT), cm_CurrentClick will be equal to the negative ID. So if the button ID is 2, cm_CurrentClick will be equal to -2.

You can make buttons that change pages, for example, by making a rule with the condition cm_CurrentClick == [ID] and the action cm_CurrentPage = [Desired Page].

The import code has two examples!

rule("'Balance the Game' Clicked")
{
    event
    {
        Ongoing - Each Player;
        All;
        All;
    }

    conditions
    {
        Event Player.cm_CurrentClick == 1;
    }

    actions
    {
        Declare Team Victory(Opposite Team Of(Team Of(Event Player)));
    }
}

rule("'Nerf Genji' Clicked")
{
    event
    {
        Ongoing - Each Player;
        All;
        All;
    }

    conditions
    {
        Event Player.cm_CurrentClick == 2;
    }

    actions
    {
        Damage(Event Player, Null, 50);
        Communicate(Event Player, Need Healing);
    }
}

Sources

This post utilizes other codes either in part or in full. This could be because they remixed them, used parts of them, were inspired by them, or other reasons.