Atlas Types

From WorldForgeWiki
Jump to: navigation, search

root_type

Type hierarchy starts from here.

  • objtype: meta
  • parent: root
  • members:


float

Floating point number.

C equivalent roughly: double

  • objtype: data_type
  • parent: root_type
  • members:


e_float

Root type for all float type example attributes

  • objtype: type
  • parent: float
  • members:


e_drunkness

  • parent: e_float
  • members:


e_height

  • parent: e_float
  • members:


e_status

  • parent: e_float
  • members:


e_width

  • parent: e_float
  • members:


height

height of something

  • objtype: type
  • parent: float
  • members:


seconds

Time in seconds

  • objtype: type
  • parent: float
  • members:


future_seconds

Time in seconds to add current time

  • parent: seconds
  • members:


stamp

Last time this object was modified.

Value should be reflect when something was

   changed in this object. Any scheme is ok as long as newer numbers
   are bigger than older stamps. For example, seconds since Jan 1st,
   1970 or total game cycles would both be valid.
  • objtype: type
  • parent: float
  • members:


stamp_contains

Last time any object that uses this as reference recursively has been modified

Value should be reflect when something was changed in some object that is contained by this object.

  • objtype: type
  • parent: stamp
  • members:


stamp_inherit

Last time any object that inherits from this has been modified

Value should be reflect when something was changed in some object that inherits from this.

  • objtype: type
  • parent: stamp
  • members:


width

width of something

  • objtype: type
  • parent: float
  • members:


int

Integer.

C equivalent: 32bit int

  • objtype: data_type
  • parent: root_type
  • members:


e_int

Root type for all int type example attributes

  • objtype: type
  • parent: int
  • members:


e_amount

  • parent: e_int
  • members:


e_attack

  • parent: e_int
  • members:


e_HP

  • parent: e_int
  • members:


list_length

Length for lists

  • objtype: type
  • parent: int
  • members:


serialno

Serial number.

  • objtype: type
  • parent: int
  • members:


lineno

linenumber where something is

  • parent: serialno
  • members:


refno

Reference to serial number.

  • parent: serialno
  • members:


list

List of objects

C equivalent: void *[]

  • objtype: data_type
  • parent: root_type
  • members:
<list name="added_attributes">
</list>


args

List of arguments this operation has

  • objtype: type
  • parent: list
  • members:


e_list

Root type for all list type example attributes

  • objtype: type
  • parent: list
  • members:


e_polygon

  • parent: e_list
  • members:


example

Gives some examples usage

  • objtype: type
  • parent: list
  • members:


grid_data

grid data

  • objtype: type
  • parent: list
  • members:


line_data

line object

  • objtype: type
  • parent: list
  • members:


map

Mapping between string key and value object

C equivalent: struct map {char *;void *}; map*

  • objtype: data_type
  • parent: root_type
  • name: mapping
  • members:
<list name="added_attributes">
</list>


specification_file

various info about object and its specification file

  • objtype: type
  • parent: map
  • members:


string

UTF-8 encoded string.

Any character is allowed, including 8 bit control characters and '\0', C equivalent: {int len; char *data;}, C++: string

  • objtype: data_type
  • parent: root_type
  • members:


e_string

Root type for all string type example attributes

  • objtype: type
  • parent: string
  • members:


e_bar

  • parent: e_string
  • members:


e_msg

  • parent: e_string
  • members:


e_sex

  • parent: e_string
  • members:


e_smell

  • parent: e_string
  • members:


e_surface_type

  • parent: e_string
  • members:


html

String that is actually html.

  • objtype: type
  • parent: string
  • members:


description

This gives short description of object.

  • parent: html
  • members:


args_description

This gives description about arguments.

  • parent: description
  • members:


long_description

This gives long description of object.

  • parent: description
  • members:


message

Some message (for example error message)

  • objtype: type
  • parent: string
  • members:


say

What something has said.

  • parent: message
  • members:


name

Name of object.

  • objtype: type
  • parent: string
  • members:


objtype

What kind of object this is.

Examples of values: "op", "class", "type".

  • objtype: type
  • parent: string
  • name: object type
  • members:


password

Password for account usually

  • objtype: type
  • parent: string
  • members:


specification

What specification this object is part of?

  • objtype: type
  • parent: string
  • members:


time_string

Time in string format: YYYY-MM-DD HH:MM:SS.ss

There can be variation in length of different fields if using some weird calendar

  • objtype: type
  • parent: string
  • members:


uri

URI (URL) of object

C equivalent roughly: for storing id name: char *, as pointer: void *
URI is Uniform Resource Locator. For more about URI see <a href="http://www.ics.uci.edu/pub/ietf/uri/">http://www.ics.uci.edu/pub/ietf/uri/</a>

  • objtype: type
  • parent: string
  • members:


e_uri

Root type for all uri type example attributes

  • parent: uri
  • members:


filename

name of file (example: where object was specified)

  • parent: uri
  • members:


id

Id of object

C equivalent roughly: for storing id name: char *, as pointer: void *

  • parent: uri
  • members:


from

Source of message/operation.

  • parent: id
  • members:


interface

What kind of operations are legal for this object.

  • parent: id
  • members:


loc

Reference object for coordinates (location).

  • objtype: type
  • parent: id
  • name: location
  • members:


to

Target of message/operation.

When client sends operation to its character in server, then you can omit this because server can assume character can only control directly its body.

  • parent: id
  • members:

media

media id reference

  • parent: uri
  • members:


username

Username for account usually

  • objtype: type
  • parent: string
  • members: