Skip to content

README.md

Latest commit

 

History

History
146 lines (114 loc) · 3.41 KB

README.md

File metadata and controls

146 lines (114 loc) · 3.41 KB

[CRC][TS] alt:V Native Menu

Supported by CRC

This is considered a utility component for rendering basic menus with various abilities such as

  • Invoking an event
  • Cycling through selections
  • Cycling through colors
  • Text input

Requires

Highly recommended to get the extension, for better event handling.

Installation

  1. Install the Instruction Buttons Utility

  2. Create a folder in your src folder called crc-native-menu.

  3. Add the TypeScript files from this resource, to that folder.

  4. Modify server.toml and ensure it loads whatever you named the folder.

In the case of the example above it should be crc-login.

resources = [ 
    'crc-db',
    'crc-native-menu',
    'crc-login',
    'core',
    'dbg_reconnect'
]

Your resource structure may vary

Usage

  • There is not a limitation on the amount of options you can have.

Create Menu

const myMenu = {
    header: 'My Menu',
    options: [
        {
            text: 'Invoke Event',
            type: 'invoke',
            value: 'any-value-you-want',
            eventName: 'my-event-onInvoke',
        },
        {
            text: 'My Selection Group',
            type: 'selection',
            eventName: 'my-event-onChange',
            index: 0,
            options: [
                {
                    text: 'afdsfdsfdsdsss',
                    value: 'a',
                },
                {
                    text: 'b',
                    value: 'b',
                },
            ],
        },
        {
            text: 'My Color Group',
            type: 'color',
            eventName: 'my-event-onColorChange',
            index: 0,
            options: [
                {
                    text: 'red',
                    color: new alt.RGBA(255, 0, 0, 255),
                    value: 0,
                },
                {
                    text: 'green',
                    color: new alt.RGBA(0, 255, 0, 255),
                    value: 1,
                },
            ],
        },
        {
            text: 'Input',
            type: 'input',
            eventName: 'my-event-onTextChange',
            value: 'initial value',
        },
    ],
};

alt.emit('crc-native-menu', { create: myMenu });

alt.on('my-event-onInvoke', (value: any) => {});
alt.on('my-event-onChange', (value: any) => {});
alt.on('my-event-onColorChange', (value: number) => {});
alt.on('my-event-onTextChange', (text: string | undefined) => {});

Destroy Menu

alt.emit('crc-native-menu', { destroy: true });

Prevent Menu from Exiting

If you want a menu to stop from exiting entirely, you can use the noExit flag.

const myMenu = {
    header: 'My Menu',
    noExit: true,
    options: []
}

Call Event on Backspace

If you want the menu to call an event when backspace is pressed. You can use the backEvent property.

const myMenu = {
    header: 'My Menu',
    backEvent: 'some-some-previous-menu-tree',
    options: []
}

Preview