SDK Attributes


The Active Worlds SDK uses attributes for communicating data back and forth between the application and the SDK. Attributes are similar to variables in that they store values that can be queried and changed. Many SDK attributes are read only, meaning that they cannot be changed by the application and exist only for communicating information to the application from the SDK.

Attributes are stored per-instance. This means that in a multi-instance application setting an attribute sets it for the current instance only.

Typically, in order to pass data into the SDK, an SDK application sets one or more attributes before calling an SDK method. Once the method completes, the application then queries one or more attributes to retrieve the results of the operation or event.

Attributes can have one of four data types:

  • int - A 32-bit integer value. Use aw_int to query the value of integer attributes and aw_int_set to set them.

  • string - A multi-character string from 0 to 255 bytes long. Use aw_string to query the value of string attributes and aw_string_set to set them.

  • bool - A boolean flag indicating either true (1) or false (0). Use aw_bool to query the value of boolean attributes and aw_bool_set to set them.

  • float - A 32-bit floating point (i.e. non-integer) numeric value. Use aw_float to query the value of floating point attributes and aw_float_set to set them.

  • data - A char* pointer to a data buffer. Use aw_data to query the value of floating point attributes and aw_data_set to set them.

Attribute Type Read only?
AW_AVATAR_ADDRESS int
AW_AVATAR_CITIZEN int
AW_AVATAR_GESTURE int
AW_AVATAR_NAME string
AW_AVATAR_PITCH int
AW_AVATAR_PRIVILEGE int
AW_AVATAR_SESSION int
AW_AVATAR_STATE int
AW_AVATAR_TYPE int
AW_AVATAR_VERSION int
AW_AVATAR_X int
AW_AVATAR_Y int
AW_AVATAR_YAW int
AW_AVATAR_Z int
AW_CELL_COMBINE bool  
AW_CELL_ITERATOR int  
AW_CELL_SEQUENCE int
AW_CELL_SIZE int
AW_CELL_X int
AW_CELL_Z int
AW_CHAT_MESSAGE string
AW_CHAT_SESSION int
AW_CHAT_TYPE int
AW_CITIZEN_BETA bool  
AW_CITIZEN_BOT_LIMIT int  
AW_CITIZEN_COMMENT string  
AW_CITIZEN_EMAIL string  
AW_CITIZEN_ENABLED bool  
AW_CITIZEN_EXPIRATION_TIME int  
AW_CITIZEN_IMMIGRATION_TIME int
AW_CITIZEN_LAST_LOGIN int
AW_CITIZEN_NAME string  
AW_CITIZEN_NUMBER int  
AW_CITIZEN_PASSWORD string  
AW_CITIZEN_PRIVILEGE_PASSWORD string  
AW_CITIZEN_TOTAL_TIME int
AW_CITIZEN_URL int  
AW_CLICKED_SESSION int
AW_CLICKED_NAME string
AW_CONSOLE_BOLD bool  
AW_CONSOLE_BLUE int  
AW_CONSOLE_GREEN int  
AW_CONSOLE_ITALICS bool  
AW_CONSOLE_MESSAGE string  
AW_CONSOLE_RED int  
AW_DISCONNECT_REASON int
AW_EJECT_SESSION int  
AW_EJECT_DURATION int  
AW_EJECTION_ADDRESS int  
AW_EJECTION_CREATION_TIME int
AW_EJECTION_COMMENT string  
AW_EJECTION_TYPE int  
AW_EJECTION_EXPIRATION_TIME int  
AW_ENTER_GLOBAL bool  
AW_LICENSE_ALLOW_TOURISTS bool  
AW_LICENSE_COMMENT string  
AW_LICENSE_CREATION_TIME int
AW_LICENSE_EMAIL string  
AW_LICENSE_EXPIRATION_TIME int  
AW_LICENSE_HIDDEN bool  
AW_LICENSE_LAST_ADDRESS int
AW_LICENSE_LAST_START int
AW_LICENSE_NAME string  
AW_LICENSE_PASSWORD string  
AW_LICENSE_RANGE int  
AW_LICENSE_USERS int  
AW_LOGIN_APPLICATION string  
AW_LOGIN_NAME string  
AW_LOGIN_OWNER int  
AW_LOGIN_PRIVILEGE_PASSWORD string  
AW_MY_GESTURE int  
AW_MY_PITCH int  
AW_MY_STATE int  
AW_MY_TYPE int  
AW_MY_X int  
AW_MY_Y int  
AW_MY_YAW int  
AW_MY_Z int  
AW_OBJECT_ACTION string  
AW_OBJECT_BUILD_TIMESTAMP int  
AW_OBJECT_DESCRIPTION string  
AW_OBJECT_MODEL string  
AW_OBJECT_NUMBER int  
AW_OBJECT_OLD_NUMBER int  
AW_OBJECT_OLD_X int  
AW_OBJECT_OLD_Z int  
AW_OBJECT_OWNER int  
AW_OBJECT_ROLL int  
AW_OBJECT_SESSION int
AW_OBJECT_TILT int  
AW_OBJECT_X int  
AW_OBJECT_Y int  
AW_OBJECT_YAW int  
AW_OBJECT_Z int  
AW_QUERY_COMPLETE bool
AW_SERVER_BUILD int
AW_SERVER_CARETAKERS string  
AW_SERVER_ENABLED bool  
AW_SERVER_EXPIRATION int
AW_SERVER_ID int
AW_SERVER_MAX_USERS int
AW_SERVER_MORE int
AW_SERVER_NAME string  
AW_SERVER_OBJECTS int
AW_SERVER_PASSWORD string  
AW_SERVER_REGISTRY string  
AW_SERVER_SIZE int
AW_SERVER_START_RC int
AW_SERVER_STATE int
AW_SERVER_TERRAIN_NODES int
AW_SERVER_USERS int
AW_TELEPORT_WARP bool  
AW_TELEPORT_WORLD string  
AW_TELEPORT_X int  
AW_TELEPORT_Y int  
AW_TELEPORT_Z int  
AW_TELEPORT_YAW int  
AW_UNIVERSE_ALLOW_TOURISTS bool  
AW_UNIVERSE_BROWSER_BETA int  
AW_UNIVERSE_BROWSER_MINIMUM int  
AW_UNIVERSE_BROWSER_RELEASE int  
AW_UNIVERSE_BROWSER_RELEASE_22 int  
AW_UNIVERSE_BUILD_NUMBER int
AW_UNIVERSE_REGISTRATION_CHARGE string
AW_UNIVERSE_REGISTRATION_REQUIRED bool
AW_UNIVERSE_RENEWAL_CHARGE string
AW_UNIVERSE_SEARCH_URL string  
AW_UNIVERSE_TIME int
AW_UNIVERSE_WORLD_MINIMUM int  
AW_UNIVERSE_WORLD_START string  
AW_WORLD_ALLOW_3_AXIS_ROTATION bool  
AW_WORLD_ALLOW_AVATAR_COLLISION bool  
AW_WORLD_ALLOW_CITIZEN_WHISPER bool  
AW_WORLD_ALLOW_FLYING bool  
AW_WORLD_ALLOW_OBJECT_SELECT bool  
AW_WORLD_ALLOW_PASSTHRU bool  
AW_WORLD_ALLOW_TELEPORT bool  
AW_WORLD_ALLOW_TOURIST_WHISPER bool  
AW_WORLD_ALWAYS_SHOW_NAMES bool  
AW_WORLD_AMBIENT_LIGHT_BLUE int  
AW_WORLD_AMBIENT_LIGHT_GREEN int  
AW_WORLD_AMBIENT_LIGHT_RED int  
AW_WORLD_AVATAR_REFRESH_RATE int  
AW_WORLD_BACKDROP string  
AW_WORLD_BACKDROP_BLUE
(Renamed to AW_WORLD_FOG_BLUE in 3.4)
int  
AW_WORLD_BACKDROP_GREEN
(Renamed to AW_WORLD_FOG_GREEN in 3.4)
int  
AW_WORLD_BACKDROP_RED
(Renamed to AW_WORLD_FOG_RED in 3.4)
int  
AW_WORLD_BOTS_RIGHT string  
AW_WORLD_BUILD_CAPABILITY bool
AW_WORLD_BUILD_NUMBER int
AW_WORLD_BUILD_RIGHT string  
AW_WORLD_BUOYANCY float  
AW_WORLD_CARETAKER_CAPABILITY bool
AW_WORLD_CELL_LIMIT int  
AW_WORLD_CLOUDS_LAYER1_MASK string  
AW_WORLD_CLOUDS_LAYER1_OPACITY int  
AW_WORLD_CLOUDS_LAYER1_SPEED_X float  
AW_WORLD_CLOUDS_LAYER1_SPEED_Z float  
AW_WORLD_CLOUDS_LAYER1_TEXTURE string  
AW_WORLD_CLOUDS_LAYER1_TILE float  
AW_WORLD_CLOUDS_LAYER2_MASK string  
AW_WORLD_CLOUDS_LAYER2_OPACITY int  
AW_WORLD_CLOUDS_LAYER2_SPEED_X float  
AW_WORLD_CLOUDS_LAYER2_SPEED_Z float  
AW_WORLD_CLOUDS_LAYER2_TEXTURE string  
AW_WORLD_CLOUDS_LAYER2_TILE float  
AW_WORLD_CLOUDS_LAYER3_MASK string  
AW_WORLD_CLOUDS_LAYER3_OPACITY int  
AW_WORLD_CLOUDS_LAYER3_SPEED_X float  
AW_WORLD_CLOUDS_LAYER3_SPEED_Z float  
AW_WORLD_CLOUDS_LAYER3_TEXTURE string  
AW_WORLD_CLOUDS_LAYER3_TILE float  
AW_WORLD_DISABLE_AVATAR_LIST bool  
AW_WORLD_DISABLE_CHAT bool  
AW_WORLD_DISABLE_CREATE_URL bool  
AW_WORLD_DISABLE_MULTIPLE_MEDIA bool  
AW_WORLD_CREATION_TIMESTAMP int
AW_WORLD_ENABLE_TERRAIN bool  
AW_WORLD_EJECT_CAPABILITY bool
AW_WORLD_EJECT_RIGHT string  
AW_WORLD_EMINENT_DOMAIN_CAPABILITY bool
AW_WORLD_EMINENT_DOMAIN_RIGHT string  
AW_WORLD_ENTER_RIGHT string  
AW_WORLD_ENTRY_POINT String  
AW_WORLD_EXPIRATION int
AW_WORLD_FOG_BLUE int  
AW_WORLD_FOG_ENABLE bool  
AW_WORLD_FOG_GREEN int  
AW_WORLD_FOG_MINIMUM int  
AW_WORLD_FOG_MAXIMUM int  
AW_WORLD_FOG_RED int  
AW_WORLD_GRAVITY float  
AW_WORLD_GROUND string  
AW_WORLD_HOME_PAGE string  
AW_WORLD_KEYWORDS String  
AW_WORLD_LIGHT_BLUE int  
AW_WORLD_LIGHT_DRAW_BRIGHT bool  
AW_WORLD_LIGHT_DRAW_FRONT bool  
AW_WORLD_LIGHT_DRAW_SIZE int  
AW_WORLD_LIGHT_GREEN int  
AW_WORLD_LIGHT_MASK string  
AW_WORLD_LIGHT_RED int  
AW_WORLD_LIGHT_TEXTURE string  
AW_WORLD_LIGHT_X float  
AW_WORLD_LIGHT_Y float  
AW_WORLD_LIGHT_Z float  
AW_WORLD_MAX_USERS int
AW_WORLD_MAX_LIGHT_RADIUS int  
AW_WORLD_NAME string
AW_WORLD_OBJECT_COUNT int
AW_WORLD_OBJECT_PATH string  
AW_WORLD_OBJECT_REFRESH int  
AW_WORLD_PUBLIC_SPEAKER_CAPABILITY bool
AW_WORLD_PUBLIC_SPEAKER_RIGHT string  
AW_WORLD_RATING int  
AW_WORLD_RESTRICTED_RADIUS int  
AW_WORLD_SIZE int
AW_WORLD_SKY_BOTTOM_BLUE int  
AW_WORLD_SKY_BOTTOM_GREEN int  
AW_WORLD_SKY_BOTTOM_RED int  
AW_WORLD_SKY_EAST_BLUE int  
AW_WORLD_SKY_EAST_GREEN int  
AW_WORLD_SKY_EAST_RED int  
AW_WORLD_SKY_NORTH_BLUE int  
AW_WORLD_SKY_NORTH_GREEN int  
AW_WORLD_SKY_NORTH_RED int  
AW_WORLD_SKY_SOUTH_BLUE int  
AW_WORLD_SKY_SOUTH_GREEN int  
AW_WORLD_SKY_SOUTH_RED int  
AW_WORLD_SKY_TOP_BLUE int  
AW_WORLD_SKY_TOP_GREEN int  
AW_WORLD_SKY_TOP_RED int  
AW_WORLD_SKY_WEST_BLUE int  
AW_WORLD_SKY_WEST_GREEN int  
AW_WORLD_SKY_WEST_RED int  
AW_WORLD_SOUND_AMBIENT string  
AW_WORLD_SOUND_FOOTSTEP string  
AW_WORLD_SOUND_WATER_ENTER string  
AW_WORLD_SOUND_WATER_EXIT string  
AW_WORLD_SPEAK_CAPABILITY bool
AW_WORLD_SPEAK_RIGHT string  
AW_WORLD_SPECIAL_COMMANDS_RIGHT string  
AW_WORLD_SPECIAL_OBJECTS_RIGHT string  
AW_WORLD_TERRAIN_AMBIENT float  
AW_WORLD_TERRAIN_DIFFUSE float  
AW_WORLD_TITLE string  
AW_WORLD_WATER_BLUE int  
AW_WORLD_WATER_BOTTOM_MASK string  
AW_WORLD_WATER_BOTTOM_TEXTURE string  
AW_WORLD_WATER_ENABLED bool  
AW_WORLD_WATER_GREEN int  
AW_WORLD_WATER_LEVEL float  
AW_WORLD_WATER_MASK string  
AW_WORLD_WATER_OPACITY int  
AW_WORLD_WATER_RED int  
AW_WORLD_WATER_SPEED float  
AW_WORLD_WATER_SURFACE_MOVE float  
AW_WORLD_WATER_TEXTURE string  
AW_WORLD_WATER_VISIBILITY int  
AW_WORLD_WATER_WAVE_MOVE float  
AW_WORLD_WELCOME_MESSAGE string  
AW_WORLDLIST_MORE bool
AW_WORLDLIST_NAME string
AW_WORLDLIST_STATUS int
AW_WORLDLIST_USERS int
AW_TERRAIN_COMPLETE bool
AW_TERRAIN_NODE_HEIGHT_COUNT int  
AW_TERRAIN_NODE_HEIGHTS data  
AW_TERRAIN_NODE_SIZE int  
AW_TERRAIN_NODE_TEXTURE_COUNT int  
AW_TERRAIN_NODE_TEXTURES data  
AW_TERRAIN_NODE_X int  
AW_TERRAIN_NODE_Z int  
AW_TERRAIN_PAGE_X int  
AW_TERRAIN_PAGE_Z int  
AW_TERRAIN_SEQUENCE int
AW_TERRAIN_X int  
AW_TERRAIN_Z int