Class MessageForm

send

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

• Sends this message form to a player or array of players

  example

  new MessageForm({
   components: {
     title: 'Example Message Form',
     text: 'Example Body Text',
     buttons: [
       new Button({
         text: 'Accept',
       }),
       new Button({
         text: 'Decline',
       }),
     ]
   }
  }).send(player, (plr, resp) => {
   plr.sendMessage(Debug.format(resp));
   if (resp.sliderId > 100) plr.sendMessage('Slider value is over 100');
  }, (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

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

    A callback that is called when the form times out

    • • (plr: MBCPlayer): void

      • Parameters

        • plr: MBCPlayer

        Returns void

  Returns void