Vp connect universe: Difference between revisions
Jump to navigation
Jump to search
m (updated syntax highlighting tags) |
m (Callback) |
||
| Line 7: | Line 7: | ||
{{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}} | {{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}} | ||
{{sdk return code row|CONNECTION_ERROR|Error connecting to the universe server}} | {{sdk return code row|CONNECTION_ERROR|Error connecting to the universe server}} | ||
|behavior= | |||
* If a {{sdk callback|CONNECT_UNIVERSE}} callback is set this function will return immediately and return the result using the callback, otherwise it will call {{sdk method|wait}} in a loop until done. | |||
|caveats=To disconnect from a universe, {{sdk method|destroy}} must be called. | |caveats=To disconnect from a universe, {{sdk method|destroy}} must be called. | ||
|examples= | |examples= | ||
| Line 15: | Line 17: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
|seealso= | |seealso= | ||
* {{sdk callback|CONNECT_UNIVERSE}} | |||
* {{sdk method|destroy}} | * {{sdk method|destroy}} | ||
* {{sdk method|login}} | * {{sdk method|login}} | ||
}} | }} | ||
Revision as of 21:26, 13 December 2016
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 |
Hostname of uniserver; typically "universe.virtualparadise.org"
|
int port |
Port of uniserver; 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_NOT_INITIALIZED |
SDK not initialized with vp_init() yet
|
VP_RC_CONNECTION_ERROR |
Error connecting to the universe server |
Behavior
- If a
VP_CALLBACK_CONNECT_UNIVERSEcallback 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;
if(rc = vp_connect_universe(instance, "universe.virtualparadise.org", 57000))
printf("Error connecting to universe (reason %d)\n", rc);