Class MlemPlatform.Mobile

Namespace

MLEM.Misc

Assembly

MLEM.dll

The MLEM platform for mobile platforms as well as consoles. This platform opens an on-screen keyboard using the Microsoft.Xna.Framework.Input KeyboardInput class on mobile devices. Additionally, it starts a new activity whenever OpenLinkOrFile(string) is called. This listener is initialized as follows in the game's Activity class:

MlemPlatform.Current = new MlemPlatform.Mobile(KeyboardInput.Show, l => this.StartActivity(new Intent(Intent.ActionView, Uri.Parse(l))));

public class MlemPlatform.Mobile : MlemPlatform

Inheritance

object

MlemPlatform

MlemPlatform.Mobile

Inherited Members

MlemPlatform.Current

MlemPlatform.EnsureExists()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Mobile(OpenOnScreenKeyboardDelegate, Action<string>)

Creates a new mobile- and console-based platform. See MlemPlatform.Mobile class documentation for more detailed information.

public Mobile(MlemPlatform.Mobile.OpenOnScreenKeyboardDelegate openOnScreenKeyboard, Action<string> openLink = null)

Parameters

openOnScreenKeyboard MlemPlatform.Mobile.OpenOnScreenKeyboardDelegate

The function that is used to display the on-screen keyboard

openLink Action<string>

The action that is invoked to open a link in the browser, which is used for LinkCode

Methods

AddTextInputListener(GameWindow, TextInputCallback)

Adds a text input listener to this platform, if supported. The supplied listener will be called whenever a character is input.

public override void AddTextInputListener(GameWindow window, MlemPlatform.TextInputCallback callback)

Parameters

window GameWindow

The game's window

callback MlemPlatform.TextInputCallback

The callback that should be called whenever a character is pressed

OpenLinkOrFile(string)

A method that should be executed to open a link in the browser or a file explorer. This method is currently used only by MLEM.Ui's implementation of the LinkCode formatting code.

public override void OpenLinkOrFile(string link)

Parameters

link string

OpenOnScreenKeyboard(string, string, string, bool)

Opens the on-screen keyboard if one is required by the platform. Note that, if no on-screen keyboard is required, a null string should be returned.

public override Task<string> OpenOnScreenKeyboard(string title, string description, string defaultText, bool usePasswordMode)

Parameters

title string

Title of the dialog box.

description string

Description of the dialog box.

defaultText string

Default text displayed in the input area.

usePasswordMode bool

If password mode is enabled, the characters entered are not displayed.

Returns

Task<string>

Text entered by the player. Null if back was used.