Aw universe attributes change

From ActiveWiki
Jump to: navigation, search


Minimum requirements
Added in version 2.1
SDKbuild 13


int aw_universe_attributes_change (void)

Description

Changes the universe attributes.

Callback

None (returns immediately)

Notes

Only instances owned by the root account (citizen #1 - universe administrator) may use this method.

In order to propagate the changes, a successful call to this method will immediately trigger the event AW_EVENT_UNIVERSE_ATTRIBUTES in all clients currently connected to the universe.

Use extreme caution when modifying the universe attributes!

Changing the various browser number attributes may trigger instant upgrade notifications for all users. An incorrect value can cause severe problems, including possibly forcing all users to exit the system and/or all world servers to shut down.

In general, you should always first consult Activeworlds Inc. before changing the attributes in your universe.

Arguments

None

Argument attributes

AW_UNIVERSE_ALLOW_BOTS_CAV
AW_UNIVERSE_ALLOW_TOURISTS
AW_UNIVERSE_ALLOW_TOURISTS_CAV
AW_UNIVERSE_BROWSER_BETA
AW_UNIVERSE_BROWSER_MINIMUM
AW_UNIVERSE_BROWSER_RELEASE
AW_UNIVERSE_CAV_PATH
AW_UNIVERSE_CAV_PATH2
AW_UNIVERSE_NOTEPAD_URL
AW_UNIVERSE_OBJECT_REFRESH
AW_UNIVERSE_OBJECT_PASSWORD
AW_UNIVERSE_SEARCH_URL
AW_UNIVERSE_WELCOME_MESSAGE
AW_UNIVERSE_WORLD_BETA
AW_UNIVERSE_WORLD_MINIMUM
AW_UNIVERSE_WORLD_RELEASE
AW_UNIVERSE_WORLD_START

Return values

RC_SUCCESS
RC_NOT_INITIALIZED
RC_NO_INSTANCE
RC_NO_CONNECTION
The connection to the universe is down.

Returned attributes

None

Usage

Change the start world for this universe.

aw_string_set (AW_UNIVERSE_WORLD_START, "welcome");

if (aw_universe_attributes_change () != RC_SUCCESS)
  printf ("Unable to change universe attributes");

See also