phaser/resources/docgen/output/Phaser.Net.json

{"class":{"name":"Phaser.Net","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"Phaser.Net handles browser URL related tasks such as checking host names, domain names and query string manipulation."},"consts":[],"methods":{"public":[{"name":"checkDomainName","static":false,"returns":{"types":["boolean"],"help":"true if the given domain fragment can be found in the window.location.hostname"},"help":"Compares the given domain name against the hostname of the browser containing the game.\\nIf the domain name is found it returns true.\\nYou can specify a part of a domain, for example 'google' would match 'google.com', 'google.co.uk', etc.\\nDo not include 'http:\/\/' at the start.","line":48,"public":true,"protected":false,"private":false,"parameters":[{"name":"domain","type":["string"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"decodeURI","static":false,"returns":{"types":["string"],"help":"The decoded value."},"help":"Returns the Query String as an object.\\nIf you specify a parameter it will return just the value of that parameter, should it exist.","line":160,"public":true,"protected":false,"private":false,"parameters":[{"name":"value","type":["string"],"help":"The URI component to be decoded.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getHostName","static":false,"returns":{"types":["string"],"help":""},"help":"Returns the hostname given by the browser.","line":28,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getQueryString","static":false,"returns":{"types":["string","object"],"help":"An object containing the key value pairs found in the query string or just the value if a parameter was given."},"help":"Returns the Query String as an object.\\nIf you specify a parameter it will return just the value of that parameter, should it exist.","line":124,"public":true,"protected":false,"private":false,"parameters":[{"name":"parameter","type":["string"],"help":"If specified this will return just the value for that key.","optional":true,"default":"''"}],"inherited":false,"inheritedFrom":""},{"name":"updateQueryString","static":false,"returns":{"types":["string"],"help":"If redirect is false then the modified url and query string is returned."},"help":"Updates a value on the Query String and returns it in full.\\nIf the value doesn't already exist it is set.\\nIf the value exists it is replaced with the new value given. If you don't provide a new value it is removed from the query string.\\nOptionally you can redirect to the new url, or just return it as a string.","line":65,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The querystring key to update.","optional":false,"default":null},{"name":"value","type":["string"],"help":"The new value to be set. If it already exists it will be replaced.","optional":false,"default":null},{"name":"redirect","type":["boolean"],"help":"If true the browser will issue a redirect to the url with the new querystring.","optional":false,"default":null},{"name":"url","type":["string"],"help":"The URL to modify. If none is given it uses window.location.href.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}}