mirror of
https://github.com/copyrighttxt/watrbx-game-engine.git
synced 2026-09-05 21:27:48 +00:00
421 lines
14 KiB
HTML
421 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Index</title>
|
|
|
|
|
|
|
|
|
|
|
|
<meta property="og:title" content=""/>
|
|
<meta property="og:type" content="website"/>
|
|
<meta property="og:image" content=""/>
|
|
|
|
<meta property="og:url" content=""/>
|
|
|
|
<script src="scripts/prettify/prettify.js"></script>
|
|
<script src="scripts/prettify/lang-css.js"></script>
|
|
<script src="scripts/jquery.min.js"></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jaguar.css">
|
|
|
|
|
|
<script>
|
|
var config = {"monospaceLinks":false,"cleverLinks":false,"applicationName":"RobloxHybrid API","disqus":"","googleAnalytics":"","openGraph":{"title":"","type":"website","image":"","site_name":"","url":""},"meta":{"title":"","description":"","keyword":""},"default":{"outputSourceFiles":true},"linenums":true};
|
|
</script>
|
|
|
|
|
|
|
|
</head>
|
|
<body>
|
|
<div id="wrap" class="clearfix">
|
|
|
|
<div class="navigation">
|
|
<h3 class="applicationName"><a href="index.html">RobloxHybrid API</a></h3>
|
|
|
|
<div class="search">
|
|
<input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations">
|
|
</div>
|
|
<ul class="list">
|
|
|
|
<li class="item" data-name="module:events.Slot">
|
|
<span class="title">
|
|
<a href="module-events.Slot.html">module:events.Slot</a>
|
|
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li data-name="module:events.Slot#emit"><a href="module-events.Slot.html#emit">emit</a></li>
|
|
|
|
<li data-name="module:events.Slot#subscribe"><a href="module-events.Slot.html#subscribe">subscribe</a></li>
|
|
|
|
<li data-name="module:events.Slot#unsubscribe"><a href="module-events.Slot.html#unsubscribe">unsubscribe</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="analytics">
|
|
<span class="title">
|
|
analytics
|
|
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li data-name="module:analytics.trackEvent"><a href="module-analytics.html#.trackEvent">trackEvent</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="bridge">
|
|
<span class="title">
|
|
bridge
|
|
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li data-name="module:bridge.CallbackStatus"><a href="module-bridge.html#.CallbackStatus">CallbackStatus</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li data-name="module:bridge.execute"><a href="module-bridge.html#.execute">execute</a></li>
|
|
|
|
<li data-name="module:bridge.nativeCallback"><a href="module-bridge.html#.nativeCallback">nativeCallback</a></li>
|
|
|
|
<li data-name="module:bridge.nativeCallback"><a href="module-bridge.html#.nativeCallback">nativeCallback</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="camera">
|
|
<span class="title">
|
|
camera
|
|
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li data-name="module:camera.cleanup"><a href="module-camera.html#.cleanup">cleanup</a></li>
|
|
|
|
<li data-name="module:camera.getPicture"><a href="module-camera.html#.getPicture">getPicture</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="console">
|
|
<span class="title">
|
|
console
|
|
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li data-name="module:console.error"><a href="module-console.html#.error">error</a></li>
|
|
|
|
<li data-name="module:console.log"><a href="module-console.html#.log">log</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="events">
|
|
<span class="title">
|
|
events
|
|
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="utils">
|
|
<span class="title">
|
|
utils
|
|
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li data-name="module:utils.extend"><a href="module-utils.html#.extend">extend</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li data-name="module:utils.createUUID"><a href="module-utils.html#.createUUID">createUUID</a></li>
|
|
|
|
<li data-name="module:utils.isMobile"><a href="module-utils.html#.isMobile">isMobile</a></li>
|
|
|
|
<li data-name="module:utils.isMobileApp"><a href="module-utils.html#.isMobileApp">isMobileApp</a></li>
|
|
|
|
<li data-name="module:utils.loadScript"><a href="module-utils.html#.loadScript">loadScript</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="chat">
|
|
<span class="title">
|
|
chat
|
|
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li data-name="roblox.module:chat.newMessageNotification"><a href="roblox.module_chat.html#.newMessageNotification">newMessageNotification</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="dialogs">
|
|
<span class="title">
|
|
dialogs
|
|
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li data-name="roblox.module:dialogs.alert"><a href="roblox.module_dialogs.html#.alert">alert</a></li>
|
|
|
|
<li data-name="roblox.module:dialogs.confirm"><a href="roblox.module_dialogs.html#.confirm">confirm</a></li>
|
|
|
|
<li data-name="roblox.module:dialogs.prompt"><a href="roblox.module_dialogs.html#.prompt">prompt</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="game">
|
|
<span class="title">
|
|
game
|
|
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li data-name="roblox.module:game.launchPartyForPlaceId"><a href="roblox.module_game.html#.launchPartyForPlaceId">launchPartyForPlaceId</a></li>
|
|
|
|
<li data-name="roblox.module:game.startWithPlaceID"><a href="roblox.module_game.html#.startWithPlaceID">startWithPlaceID</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="network">
|
|
<span class="title">
|
|
network
|
|
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li data-name="roblox.module:network.status"><a href="roblox.module_network.html#.status">status</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li data-name="roblox.module:network.getStatus"><a href="roblox.module_network.html#.getStatus">getStatus</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="item" data-name="social">
|
|
<span class="title">
|
|
social
|
|
|
|
</span>
|
|
<ul class="members itemMembers">
|
|
|
|
<span class="subtitle">Members</span>
|
|
|
|
<li data-name="roblox.module:social.providers"><a href="roblox.module_social.html#.providers">providers</a></li>
|
|
|
|
</ul>
|
|
<ul class="typedefs itemMembers">
|
|
|
|
</ul>
|
|
<ul class="methods itemMembers">
|
|
|
|
<span class="subtitle">Methods</span>
|
|
|
|
<li data-name="roblox.module:social.login"><a href="roblox.module_social.html#.login">login</a></li>
|
|
|
|
<li data-name="roblox.module:social.logout"><a href="roblox.module_social.html#.logout">logout</a></li>
|
|
|
|
<li data-name="roblox.module:social.presentShareDialog"><a href="roblox.module_social.html#.presentShareDialog">presentShareDialog</a></li>
|
|
|
|
</ul>
|
|
<ul class="events itemMembers">
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
<div class="main">
|
|
<h1 class="page-title" data-filename="index.html">Index</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3> </h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article class="readme"><h2>RobloxHybrid API Reference</h2><ul>
|
|
<li><a href=""></a></li>
|
|
</ul>
|
|
<h2>Usage</h2><p>In order to use this library, include the following file in your html</p>
|
|
<pre class="prettyprint source lang-html"><code><script src="roblox.js" type="text/javascript"></script></code></pre><p>Then, you can reference the modules, for example Game, in the following way</p>
|
|
<pre class="prettyprint source lang-js"><code>Roblox.Hybrid.Game.startWithPlaceID("XXX", myCallback);</code></pre><p>Each module also has a "supports" function, that executes asynchronously and checks if the queried function is supported natively in the current platform.</p>
|
|
<pre class="prettyprint source lang-js"><code> Roblox.Hybrid.Game.supports("followUser", function(isSupported) {
|
|
if(isSupported) {
|
|
Roblox.Hybrid.Game.followUser("XXXXX", myCallback);
|
|
} else {
|
|
// Web implementation
|
|
}
|
|
});</code></pre><h2>How to generate the compiled RobloxHybrid.js file</h2><p>"roblox.js" is compiled and optimized with <a target="_blank" href="https://github.com/google/closure-compiler">Google Closure Compiler</a></p>
|
|
<p>In order to run this tool execute:</p>
|
|
<pre class="prettyprint source lang-sh"><code>$ ./build_js.sh</code></pre><h2>How to generate this documentation</h2><pre class="prettyprint source lang-sh"><code>$ cd docs
|
|
$ ./build_doc.sh</code></pre></article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<footer>
|
|
RobloxHybrid - Documentation generated on 11/11/2015
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
<script>prettyPrint();</script>
|
|
<script src="scripts/linenumber.js"></script>
|
|
<script src="scripts/main.js"></script>
|
|
</body>
|
|
</html> |