Class ActionForm

send

• send(plr: MBCPlayer | MBCPlayer[], onCancel?: ((plr: MBCPlayer) => void), onTimeout?: ((plr: MBCPlayer) => void)): void

• Sends this form to a player or array of players

  example

  new ActionForm({
   text: 'Example Body text',
   title: 'Example Action Form',
   buttons: [
     {
       id: 'button0',
       button: new Button({
         text: 'Button 0',
         onClick: (plr) => {
           plr.sendMessage('Clicked Button 0');
         },
       }),
     },
     {
       id: 'button1',
       button: new Button({
         text: 'Button 1',
         onClick: (plr) => {
           plr.sendMessage('Clicked Button 1');
         },
       }),
     },
     {
       id: 'button2',
       button: new Button({
         text: 'Button 2',
         onClick: (plr) => {
           plr.sendMessage('Clicked Button 2');
         },
       }),
     },
   ]
  }).send(player, (plr) => {
   plr.sendMessage('Closed modal form via cancelation');
  }, (plr) => {
   plr.sendMessage('Modal form timed out, likely due to having an existing ui open upon request');
  });
  

  Parameters

  • plr: MBCPlayer | MBCPlayer[]

    The player(s) to send this form to

  • Optional onCancel: ((plr: MBCPlayer) => void)

    A callback that is called when the form is cancelled

    • • (plr: MBCPlayer): void

      • Parameters

        • plr: MBCPlayer

        Returns void

  • Optional onTimeout: ((plr: MBCPlayer) => void)

    A callback that is called when the form times out

    • • (plr: MBCPlayer): void

      • Parameters

        • plr: MBCPlayer

        Returns void

  Returns void