SDK Reason Codes

From ActiveWiki
Jump to navigation Jump to search

Current version

Reason codeValueDescription
RC_SUCCESS 0

Success

Return value from an asynchronous call: Request has been sent to the server.
Return value from a blocking call: Operation has completed successfully.
When passed to a callback: Operation has completed successfully.

RC_CITIZENSHIP_EXPIRED 1

Citizenship has expired

Citizenship of the owner has expired.

RC_LAND_LIMIT_EXCEEDED 2

Land limit exceeded

Land limit of the universe would be exceeded if the world is started.

RC_NO_SUCH_CITIZEN 3

No such citizen

No citizenship with a matching citizen number was found.

RC_LICENSE_PASSWORD_CONTAINS_SPACE 5

License password contains space

Password cannot contain a space.

RC_LICENSE_PASSWORD_TOO_LONG 6

License password too long

Password cannot be longer than 8 characters.

RC_LICENSE_PASSWORD_TOO_SHORT 7

License password too short

Password must be at least 2 characters.

RC_LICENSE_RANGE_TOO_LARGE 8

License range too large

Range must be smaller than 3275 hectometers. That is, at most 32750 coordinates N/S/W/E or 655000 meters across.

RC_LICENSE_RANGE_TOO_SMALL 9

License range too small

Range must be larger than 0 hectometers. That is, at least 10 coordinates N/S/W/E or 200 meters across.

RC_LICENSE_USERS_TOO_LARGE 10

License users too large

User limit cannot exceed 1024.

RC_LICENSE_USERS_TOO_SMALL 11

License users too small

User limit must be larger than 0.

RC_INVALID_PASSWORD 13

Invalid password

Unable to login due to invalid password.

RC_LICENSE_WORLD_TOO_SHORT 15

License world too short

Name must be at least 2 characters.

RC_LICENSE_WORLD_TOO_LONG 16

License world too long

Name cannot be longer than 8 characters.

RC_MUST_UPGRADE 18

SDK update required

The used SDK build is obsolete. Update to recent SDK build number. Similar to RC#58.

RC_INVALID_WORLD 20

Invalid world

Unable to start the world due to invalid name or password.

RC_SERVER_OUTDATED 21

Server outdated

Server build either contains a serious flaw or is outdated and must be upgraded.

RC_WORLD_ALREADY_STARTED 22

World already started

World has already been started at a different location.

RC_NO_SUCH_WORLD 27

No such world

No world with a matching name has been started on the server.

RC_UNAUTHORIZED 32

Unauthorized

Not authorized to perform the operation.

RC_NO_SUCH_LICENSE 34

No such license

No license with a matching world name was found.

RC_TOO_MANY_WORLDS 57

Too many worlds

Limit of started worlds in the universe would be exceeded if the world is started.

RC_MUST_UPGRADE 58

Must upgrade

SDK build either contains a serious flaw or is outdated and must be upgraded.

RC_BOT_LIMIT_EXCEEDED 59

Bot limit exceeded

Bot limit of the owner citizenship would be exceeded if the bot is logged in.

RC_WORLD_EXPIRED 61

World expired

Unable to start world due to its license having expired.

RC_CITIZEN_DOES_NOT_EXPIRE 62

Citizen does not expire

TODO: What is this used for?

RC_LICENSE_STARTS_WITH_NUMBER 64

License starts with number

Name cannot start with a number.

RC_NO_SUCH_EJECTION 66

No such ejection

No ejection with a matching identifier was found.

RC_NO_SUCH_SESSION 67

No such session

No user with a matching session number has entered the world.

RC_WORLD_RUNNING 72

World running

World has already been started.

RC_WORLD_NOT_SET 73

World not set

World to perform the operation on has not been set.

RC_NO_SUCH_CELL 74

No such cell

No more cells left to enumerate.

RC_NO_REGISTRY 75

No registry

Unable to start world due to missing or invalid registry.

RC_CANT_OPEN_REGISTRY 76 Can't open registry
RC_CITIZEN_DISABLED 77

Citizen disabled

Citizenship of the owner has been disabled.

RC_WORLD_DISABLED 78

World disabled

Unable to start world due to it being disabled.

RC_TELEGRAM_BLOCKED 85 Telegram blocked
RC_UNABLE_TO_UPDATE_TERRAIN 88 Unable to update terrain
RC_EMAIL_CONTAINS_INVALID_CHAR 100

Email contains invalid char

Email address contains one or more invalid characters.

RC_EMAIL_ENDS_WITH_BLANK 101

Email ends with blank

Email address cannot end with a blank.

RC_NO_SUCH_OBJECT 101

No such object

Unable to find the object to delete.

RC_EMAIL_MISSING_DOT 102

Email missing dot

Email address must contain at least one '.'.

RC_NOT_DELETE_OWNER 102 Not delete owner
RC_EMAIL_MISSING_AT 103

Email missing at

Email address must contain a '@'.

RC_EMAIL_STARTS_WITH_BLANK 104

Email starts with blank

Email address cannot start with a blank.

RC_EMAIL_TOO_LONG 105

Email too long

Email address cannot be longer than 50 characters.

RC_EMAIL_TOO_SHORT 106

Email too short

Email address must be at least 8 characters or longer.

RC_NAME_ALREADY_USED 107

Name already used

Citizenship with a matching name already exists.

RC_NAME_CONTAINS_NONALPHANUMERIC_CHAR 108

Name contains nonalphanumeric character

Name contains invalid character(s).

RC_NAME_CONTAINS_INVALID_BLANK 109

Name contains invalid blank

Name contains invalid blank(s).

RC_NAME_ENDS_WITH_BLANK 111

Name ends with blank

Name cannot end with a blank.

RC_NAME_TOO_LONG 112

Name too long

Name cannot be longer than 20 characters.

RC_NAME_TOO_SHORT 113

Name too short

Name must be at least 4 characters.

RC_PASSWORD_TOO_LONG 115

Password too long

Password cannot be longer than 16 characters.

RC_PASSWORD_TOO_SHORT 116

Password too short

Password must be at least 8 characters.

RC_UNABLE_TO_DELETE_CITIZEN 124

Unable to delete citizen

Unable to delete citizen due to a database problem.

RC_NUMBER_ALREADY_USED 126

Number already used

Citizenship with a matching citizen number already exists.

RC_NUMBER_OUT_OF_RANGE 127

Number out of range

Citizen number is larger than the auto-incremented field in the database.

RC_PRIVILEGE_PASSWORD_IS_TOO_SHORT 128

Privilege password is too short

Privilege password must be either empty or at least 4 characters.

RC_PRIVILEGE_PASSWORD_IS_TOO_LONG 129

Privilege password is too long

Password cannot be longer than 12 characters.

RC_NOT_CHANGE_OWNER 203

Not change owner

Not permitted to change the owner of an object. It requires eminent domain or caretaker capability.

RC_CANT_FIND_OLD_ELEMENT 204

Can't find old element

Unable to find the object to change.

RC_IMPOSTER 212

Imposter

Unable to enter world due to masquerading as someone else.

RC_ENCROACHES 300

Encroaches

Not allowed to encroach into another's property.

RC_OBJECT_TYPE_INVALID 301 Object type invalid
RC_TOO_MANY_BYTES 303

Too many bytes

Cell limit would be exceeded.

RC_UNREGISTERED_OBJECT 306

Unregistered object

Model name does not exist in the registry.

RC_ELEMENT_ALREADY_EXISTS 308 Element already exists
RC_RESTRICTED_COMMAND 309 Restricted command
RC_OUT_OF_BOUNDS 311 Out of bounds
RC_RESTRICTED_OBJECT 313

Restricted object

Not allowed to build with 'z' objects in this world. [the same error code is used for V4 objects]

RC_RESTRICTED_AREA 314

Restricted area

Not allowed to build within the restricted area of this world.

RC_NOT_YET 401

Not yet

Would exceed the maximum number of operations per second.

RC_TIMEOUT 402

Timeout

Synchronous operation timed out.

RC_UNABLE_TO_CONTACT_UNIVERSE 404

Unable to contact universe

Unable to establish a connection to the universe server.

RC_NO_CONNECTION 439

No connection

Connection to the server is down.

RC_NOT_INITIALIZED 444

Not initialized

SDK API has not been initialized (by calling aw_init).

RC_NO_INSTANCE 445 No instance
RC_INVALID_ATTRIBUTE 448 Invalid attribute
RC_TYPE_MISMATCH 449 Type mismatch
RC_STRING_TOO_LONG 450 String too long
RC_READ_ONLY 451

Read only

Unable to set attribute due to it being read-only.

RC_INVALID_INSTANCE 453 Invalid instance
RC_VERSION_MISMATCH 454

Version mismatch

Aw.h and Aw.dll (or libaw_sdk.so for Linux) are from different builds of the SDK.

RC_QUERY_IN_PROGRESS 464

Query in progress

A property query is already in progress.

RC_EJECTED 466

Ejected

Disconnected from world due to ejection.

RC_NOT_WELCOME 467

Not welcome

Citizenship of the owner does not have bot rights in the world.

RC_CONNECTION_LOST 471 Connection lost
RC_NOT_AVAILABLE 474 Not available
RC_CANT_RESOLVE_UNIVERSE_HOST 500 Can't resolve universe host
RC_INVALID_ARGUMENT 505 Invalid argument
RC_UNABLE_TO_UPDATE_CAV 514 Unable to update custom avatar
RC_UNABLE_TO_DELETE_CAV 515 Unable to delete custom avatar
RC_NO_SUCH_CAV 516 No such custom avatar
RC_WORLD_INSTANCE_ALREADY_EXISTS 521 World instance already exists
RC_WORLD_INSTANCE_INVALID 522 World instance invalid
RC_PLUGIN_NOT_AVAILABLE 523 Plugin not available
RC_DATABASE_ERROR 600 Database error
RC_Z_BUF_ERROR 4995

Buffer error (zlib)

Not enough room in the output buffer.

RC_Z_MEM_ERROR 4996

Memory error (zlib)

Memory could not be allocated for processing.

RC_Z_DATA_ERROR 4997

Data error (zlib)

Input data was corrupted.

Addition older reason codes, not used by the free SDK

Reason codeValueDescription
RC_MESSAGE_LENGTH_BAD 4 Message length bad
RC_LICENSE_CONTAINS_INVALID_CHAR 12 License contains invalid character
RC_SERVER_OUT_OF_MEMORY 17 Server out of memory
RC_NOT_LOGGED_IN 31

Not logged in

Must be logged in to perform the operation.

RC_WORLD_ALREADY_EXISTS 33

World already exists

Name already exists.

RC_NO_SUCH_ACTING_CITIZEN 42 No such acting citizen
RC_ACTING_PASSWORD_INVALID 43 Acting password invalid
RC_EJECTION_EXPIRED 69

Ejection expired

Attempting to add an ejection that has already expired.

RC_ACTING_CITIZEN_EXPIRED 70 Acting citizen expired
RC_ALREADY_STARTED 71 Already started
RC_ACTING_CITIZEN_DISABLED 80 Acting citizen disabled
RC_TELEGRAM_TOO_LONG 86 Telegram too long
RC_NAME_DOESNT_EXIST 110 Name doesn't exist
RC_NAME_UNUSED 114 Name unused
RC_PASSWORD_WRONG 117

Password wrong

TODO: Where is this used?

RC_UNABLE_TO_DELETE_NAME 119 Unable to delete name
RC_UNABLE_TO_GET_CITIZEN 120 Unable to get citizen
RC_UNABLE_TO_INSERT_CITIZEN 121 Unable to insert citizen
RC_UNABLE_TO_INSERT_NAME 122 Unable to insert name
RC_UNABLE_TO_PUT_CITIZEN_COUNT 123 Unable to put citizen count
RC_UNABLE_TO_CHANGE_ATTRIBUTE 210 Unable to change attribute
RC_INVALID_REQUEST 213 Invalid request
RC_CANT_BUILD_HERE 216 Can't build here
RC_UNABLE_TO_STORE 305 Unable to store
RC_NO_BUILD_RIGHTS 310 No build rights
RC_OUT_OF_MEMORY 400 Out of memory
RC_NULL_POINTER 403 Null pointer
RC_UNABLE_TO_CONTACT_WORLD 405 Unable to contact world
RC_INVALID_WORLD_NAME 406 Invalid world name
RC_SEND_FAILED 415 Send failed
RC_RECEIVE_FAILED 416

Receive failed

Unable to receive data from network socket.
This can occur for any number of reasons. But in general, it means some kind of network communication problem has occurred.
It could be that the peer host has disconnected, peer host failed to respond in time, connection is being blocked by a firewall, or anything else that would interfere with socket communications.

RC_STREAM_EMPTY 421 Stream empty
RC_STREAM_MESSAGE_TOO_LONG 422 Stream message too long
RC_WORLD_NAME_TOO_LONG 423 World name too long
RC_MESSAGE_TOO_LONG 426 Message too long
RC_UNABLE_TO_CREATE_SOCKET 428 Unable to create socket
RC_UNABLE_TO_CONNECT 429 Unable to connect
RC_UNABLE_TO_SET_NONBLOCKING 430 Unable to set nonblocking
RC_CANT_OPEN_STREAM 434 Can't open stream
RC_CANT_WRITE_STREAM 435 Can't write stream
RC_CANT_CLOSE_STREAM 436 Can't close stream
RC_UNABLE_TO_INITIALIZE_NETWORK 442 Unable to initialize network
RC_INCORRECT_MESSAGE_LENGTH 443 Incorrect message length
RC_OUT_BUFFER_FULL 446 Out buffer full
RC_INVALID_CALLBACK 447 Invalid callback
RC_IN_BUFFER_FULL 461 In buffer full
RC_PROTOCOL_ERROR 463 Protocol error
RC_NO_STREAM 473 No stream
RC_OLD_UNIVERSE 487

Old universe

Universe is too outdated to be compatible.

RC_OLD_WORLD 488

Old world

World is too outdated to be compatible.

RC_WORLD_NOT_RUNNING 489

World not running

Unable to stop a world that is not running.

Not used by the free SDK

Reason codeValueDescription
RC_UNABLE_TO_MAIL_BACK_NUMBER 14 Unable to mail back number
RC_IDENTITY_ALREADY_IN_USE 39 Identity already in use
RC_UNABLE_TO_REPORT_LOCATION 40 Unable to report location
RC_INVALID_EMAIL 41 Invalid email
RC_UNIVERSE_FULL 45 Universe full
RC_BILLING_TIMEOUT 46 Billing timeout
RC_BILLING_RECV_FAILED 47 Billing recv failed
RC_BILLING_RESPONSE_INVALID 48 Billing response invalid
RC_BILLING_REJECTED 55 Billing rejected
RC_BILLING_BLOCKED 56 Billing blocked
RC_BETA_REQUIRED 79 Beta required
RC_INVALID_USER_COUNT 81 Invalid user count
RC_PRIVATE_WORLD 91 Private world
RC_NO_TOURISTS 92 No tourists
RC_CANT_CHANGE_OWNER 211 Can't change owner
RC_JOIN_REFUSED 250 Join refused
RC_TOO_MANY_RESETS 427 Too many resets
RC_UNABLE_TO_REGISTER_RESOLVE 452 Unable to register resolve
RC_WORLD_FULL 465 World full
RC_UNABLE_TO_BIND 468 Unable to bind
RC_UNABLE_TO_LISTEN 469 Unable to listen
RC_UNABLE_TO_ACCEPT 470 Unable to accept
RC_EMAIL_CHANGE_NOT_ALLOWED 525 Email change not allowed
RC_NAME_CHANGE_NOT_ALLOWED 526 Name change not allowed
RC_EMAIL_ALREADY_USED 527 Email already used
RC_EMAIL_NOT_ALLOWED 528 Email not allowed
RC_WORLD_REDIRECT 529

World redirect

TODO: Is this ever used in the SDK?