Aw server world set
| Minimum requirements | ||
|---|---|---|
| Added in version 3.1 | ||
| SDK | build 18 | |
| World | build 28 | |
int aw_server_world_set (int id)
Description
Sets the world that subsequent operations will be performed on.
Callback
AW_CALLBACK_ADMIN_WORLD_RESULT
Notes
This method sets the current world to id for an administration mode instance. This is necessary if the application is going to call one of several non-admin methods, including:
- aw_cell_next
- aw_delete_all_objects
- aw_object_add
- aw_object_change
- aw_object_delete
- aw_object_load
- aw_query
- aw_query_5x5
- aw_terrain_delete_all
- aw_terrain_load_node
- aw_terrain_next
- aw_terrain_query
- aw_terrain_set
- aw_world_reload_registry
- aw_world_attributes_change
- aw_world_attributes_reset
Arguments
- id
- Unique id number of a particular world configuration.
Argument attributes
None
Return values
- RC_SUCCESS (1) (2)
- RC_NOT_INITIALIZED (1)
- RC_NO_INSTANCE (1)
- RC_NO_CONNECTION (1)
- The connection to the world is down.
- RC_UNAUTHORIZED (2)
- Only world server administration instances may use this method.
- RC_NO_SUCH_WORLD (2)
- No world configuration with a matching id was found.
(1) Possible return values when a callback is installed.
(2) Returned by the world server.
Returned attributes
Example
See aw_server_world_delete for an example.