mirror of
https://github.com/wassname/GarageServer.IO.git
synced 2026-10-02 11:50:38 +08:00
Progress: Documentation
This commit is contained in:
1 parent
586b40fb1a
commit
2b9dd7c767
1 file changed
+3
-5
@@ -113,13 +113,11 @@ var playerStates = GarageServerIO.getPlayerStates(),
|
||||
GarageServerIO.initializeGarageServer(path, options)
|
||||
```
|
||||
Establish connection to GarageServer.IO on the server via Socket.IO and register events.
|
||||
```js
|
||||
path
|
||||
```
|
||||
`path`
|
||||
**Type:** string
|
||||
The URL that points to where GarageServer.IO is running at on the server.
|
||||
**options**
|
||||
Type: object literal
|
||||
`options`
|
||||
**Type:** object literal
|
||||
Configure the different options, events, callbacks that you would like to consume on the client.
|
||||
```js
|
||||
options.onPlayerConnect(callback)
|
||||
|
||||
Reference in new issue
Block a user