Cave Software Keyboard API

These methods are part of the cave JavaScript API, they allow you to call the 3DS's various built-in keyboards to prompt the user for input.

Methods

swkbd_callFullKeyboard

• Arguments:

  • {String} text
  • {Number} maxLength
  • {Number} minLength
  • {Boolean} isMonospace
  • {Boolean} isMultiline
  • {Boolean} isConvertible

• Returns: {String}

• Usage:

  Call the full keyboard. When the user is done, it will return the text entered.

swkbd_callFullKeyboardWithGuide

• Arguments:

  • {String} text
  • {Number} maxLength
  • {Number} minLength
  • {Boolean} isMonospace
  • {Boolean} isMultiline
  • {Boolean} isConvertible
  • {String} guide

• Returns: {String}

• Usage:

  Same as swkbd_callFullKeyboard, except you can provide an input hint.

swkbd_callNumberKeyboard

• Arguments:

  • {String} text
  • {Number} maxLength
  • {Number} minLength
  • {Number} maximum
  • {Number} minimum
  • {Boolean} isMonospace

• Returns: {Number}

• Usage:

  Call a numerical keyboard. When the user is done, it will return the number entered. The number's range is limited to between 0 and 2,147,483,647 (range of an unsigned 32-bit integer).

swkbd_callNumberKeyboardWithGuide

• Arguments:

  • {String} text
  • {Number} maxLength
  • {Number} minLength
  • {Number} maximum
  • {Number} minimum
  • {Boolean} isMonospace
  • {String} guide

• Returns: {Number}

• Usage:

  Same as swkbd_callNumberKeyboard, except you can provide an input hint.

swkbd_callAlphanumericKeyboard

• Arguments:

  • {String} text
  • {Number} maxLength
  • {Number} minLength
  • {Boolean} isMonospace
  • {Boolean} isMultiline

• Returns: {String}

• Usage:

  Call the alphanumeric keyboard. When the user is done, it will return the text entered.

swkbd_callAlphanumericKeyboardWithGuide

• Arguments:

  • {String} text
  • {Number} maxLength
  • {Number} minLength
  • {Boolean} isMonospace
  • {Boolean} isMultiline
  • {String} guide

• Returns: {String}

• Usage:

  Same as swkbd_callAlphanumericKeyboard, except you can provide an input hint.

swkbd_callAccountIdKeyboard

• Arguments:

  • {String} text
  • {Number} maxLength
  • {Number} minLength
  • {Boolean} isMonospace

• Returns: {String}

• Usage:

  Prompt the user to enter an account ID. Will return the text entered.

swkbd_callAccountIdKeyboardWithGuide

• Arguments:

  • {String} text
  • {Number} maxLength
  • {Number} minLength
  • {Boolean} isMonospace
  • {String} guide

• Returns: {String}

• Usage:

  Same as swkbd_callAccountIdKeyboard, except you can provide an input hint.

swkbd_callEmailKeyboard

• Arguments:

  • {String} text
  • {Number} maxLength
  • {Number} minLength
  • {Boolean} isMonospace

• Returns: {String}

• Usage:

  Prompt the user to enter an email address. Will return the text entered.

swkbd_callEmailKeyboardWithGuide

• Arguments:

  • {String} text
  • {Number} maxLength
  • {Number} minLength
  • {Boolean} isMonospace
  • {String} guide

• Returns: {String}

• Usage:

  Same as swkbd_callEmailKeyboard, except you can provide an input hint.

swkbd_callPasswordKeyboard

• Arguments:

  • {String} text
  • {Number} maxLength
  • {Number} minLength
  • {Boolean} isMonospace

• Returns: {String}

• Usage:

  Prompt the user to enter a password. Will return the text entered.

swkbd_callPasswordKeyboardWithGuide

• Arguments:

  • {String} text
  • {Number} maxLength
  • {Number} minLength
  • {Boolean} isMonospace
  • {String} guide

• Returns: {String}

• Usage:

  Same as swkbd_callPasswordKeyboard, except you can provide an input hint.

swkbd_callPassnumberKeyboard

• Arguments:

  • {String} text
  • {Number} maxLength
  • {Number} minLength
  • {Number} maximum
  • {Number} minimum
  • {Boolean} isMonospace
  • {String} guide

• Returns: {Number}

• Usage:

  Prompt the user to enter a pass number. Will return the number entered. The number's range is limited to between 0 and 2,147,483,647 (range of an unsigned 32-bit integer).

swkbd_callPassnumberKeyboardWithGuide

• Arguments:

  • {String} text
  • {Number} maxLength
  • {Number} minLength
  • {Number} maximum
  • {Number} minimum
  • {Boolean} isMonospace
  • {String} guide

• Returns: {Number}

• Usage:

  Same as swkbd_callPassnumberKeyboard, except you can provide an input hint.

swkbd_callPinKeyboard

• Returns: {Boolean}

• Usage:

  Prompt the user to enter their (parental controls?) PIN. Will return true if the PIN is valid.