Aw delete all objects

From ActiveWiki
Jump to: navigation, search


Minimum requirements
Added in version 3.1
SDKbuild 18
Worldbuild 28


int aw_delete_all_objects (void)

Description

Deletes all of the objects in a world.

Callback

AW_CALLBACK_DELETE_ALL_OBJECTS_RESULT

Notes

This method provide a simple mechanism for deleting all of the objects in a world.

For a complete description of cells and property in Active Worlds, see Property.

For world build 96, or later: The world server will automatically build a "street1.rwx" object at ground zero after deleting everything.

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

Usage

Delete all objects in the world.

int rc;

rc = aw_delete_all_objects ();
if (rc = RC_SUCCESS)
  printf ("Unable to delete all objects (reason %d)\n", rc);
else
  printf ("All objects deleted. I hope you made a backup!\n");

See also