vp_connect_universe
Method call snippet
vp_connect_universe(instance, "universe.virtualparadise.org", 57000);
Connects an instance to a universe server. Required before an instance log in with user credentials and connects to any world.
Parameters
These are the parameters that this method requires:
Parameter | Usage |
---|---|
VPInstance instance |
Pointer to the instance this method call is intended for |
string host |
Host address of server to connect to; typically "universe.virtualparadise.org"
|
int port |
TCP port of remote server; typically 57000
|
Returns
This method returns a return code integer, which indicates whether the call was successful or errored for any reason:
Return code | Cause |
---|---|
VP_RC_SUCCESS |
Successful call (for methods that have a registered callback, it only means the request has been sent) |
VP_RC_CONNECTION_ERROR |
Error connecting to the universe server |
Behavior
- If a
VP_CALLBACK_CONNECT_UNIVERSE
callback is set this function will return immediately and return the result using the callback, otherwise it will callvp_wait()
in a loop until done.
Caveats
To disconnect from a universe, vp_destroy()
must be called.
Examples
int rc;
rc = vp_connect_universe(instance, "universe.virtualparadise.org", 57000);
if(rc)
printf("Couldn't connect to universe(reason %d)", rc);