utils

namespace utils

string

a collection of utility functions

Summary


Public Methods


checkVersion utils.js:20
checkVersion(v1: string, v2: string) → {number}

Compare two version strings

if (me.utils.checkVersion("7.0.0") > 0) {
    console.error(
        "melonJS is too old. Expected: 7.0.0, Got: 6.3.0"
    );
}
Parameters:
Name Type Description
v1 string

First version string to compare

v2 string

second version string to compare

Returns:
Type Description
number

Return 0 if v1 == v2, or 1 if v1 is greater, or -1 if v2 is greater

getUriFragment utils.js:50
getUriFragment(url: string) → {object}

parse the fragment (hash) from a URL and returns them into

// http://www.example.com/index.html#debug&hitbox=true&mytag=value
let UriFragment = me.utils.getUriFragment();
console.log(UriFragment["mytag"]); //> "value"
Properties:
Name Type Attributes Default Description
debug boolean

<optional>

false

display the debug panel (if preloaded)

debugToggleKey string

<optional>

"s"

show/hide the debug panel (if preloaded)

hitbox boolean

<optional>

false

draw the hitbox in the debug panel (if enabled)

quadtree boolean

<optional>

false

draw the quadtree in the debug panel (if enabled)

velocity boolean

<optional>

false

draw the entities velocity in the debug panel (if enabled)

webgl boolean

<optional>

false

force the renderer to WebGL

Parameters:
Name Type Attributes Default Description
url string

<optional>

document.location

an optional params string or URL containing fragment (hash) params to be parsed

Returns:
Type Description
object

an object representing the deserialized params string.


Powered by webdoc!