Aw world attributes reset

From ActiveWiki
Jump to: navigation, search


Minimum requirements
Added in version 3.1
SDKbuild 18
Worldbuild 28


int aw_world_attributes_reset (void)

Description

Resets all world attributes to their default values.

Callback

AW_CALLBACK_ATTRIBUTES_RESET_RESULT

Notes

This method resets all world attributes to the default values they have when a world is first created.

Arguments

None

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 or those owned by a caretaker (i.e. aw_bool (AW_WORLD_CARETAKER_CAPABILITY) returns 1) may use this method.

(1) Possible return values when a callback is installed.

(2) Returned by the world server.

Returned attributes

None

See also