Atlas Type Reference

From WorldForgeWiki
Jump to: navigation, search

Contents

root

All objects inherit from this.

You can browse all definitions starting from here and descending into childrens.

  • objtype: meta
  • stamp: 0.0
  • stamp inherit: 0.0
  • name:
  • specification: atlas
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>stamp</string>
  <string>stamp_inherit</string>
  <string>objtype</string>
  <string>interface</string>
  <string>name</string>
  <string>description</string>
  <string>long_description</string>
  <string>specification</string>
</list>
<string name="filename">root.def</string>
<int name="lineno">2</int>

element_type

Element type for typed lists/mappings

  • parent: id
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>description</string>
</list>
<string name="filename">type.def</string>
<int name="lineno">183</int>

float_list

List of floats

C equivalent: double []

  • objtype: type
  • parent: list
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>objtype</string>
  <string>element_type</string>
  <string>description</string>
  <string>long_description</string>
</list>
<string name="filename">type.def</string>
<int name="lineno">114</int>

float_list_length

List of floats with constant length

Inherit required object from this and set length attribute to suitable value.

  • objtype: meta
  • parent: float_list
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>objtype</string>
  <string>list_length</string>
  <string>description</string>
  <string>long_description</string>
</list>
<string name="filename">type.def</string>
<int name="lineno">154</int>

cell_size

cell size of grid area

  • objtype: type
  • parent: float_list_length
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>objtype</string>
  <string>list_length</string>
  <string>description</string>
</list>
<string name="filename">type.def</string>
<int name="lineno">591</int>

pos

Position coordinates, usually world is 3D

  • objtype: type
  • parent: float_list_length
  • name: position
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>name</string>
  <string>parents</string>
  <string>children</string>
  <string>objtype</string>
  <string>list_length</string>
  <string>description</string>
</list>
<string name="filename">type.def</string>
<int name="lineno">162</int>

velocity

Velocity object is moving, usually world is 3D

  • objtype: type
  • parent: float_list_length
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>objtype</string>
  <string>list_length</string>
  <string>description</string>
</list>
<string name="filename">type.def</string>
<int name="lineno">170</int>

int_list

List of integers

C equivalent: int []

  • objtype: type
  • parent: list
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>objtype</string>
  <string>element_type</string>
  <string>description</string>
  <string>long_description</string>
</list>
<string name="filename">type.def</string>
<int name="lineno">106</int>

int_list_length

List of ints with constant length

Inherit required object from this and set length attribute to suitable value.

  • objtype: meta
  • parent: int_list
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>objtype</string>
  <string>list_length</string>
  <string>description</string>
  <string>long_description</string>
</list>
<string name="filename">type.def</string>
<int name="lineno">146</int>

grid_size

size of grid area: width and height (and for space depth too) in grid units

  • objtype: type
  • parent: int_list_length
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>objtype</string>
  <string>list_length</string>
  <string>description</string>
</list>
<string name="filename">type.def</string>
<int name="lineno">584</int>

root_entity

Starting point for entity hierarchy

Later in hierarchy tree objtype changes to 'object' when actual game objects are made.

  • objtype: class
  • parent: root
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>objtype</string>
  <string>description</string>
  <string>long_description</string>
  <string>loc</string>
  <string>pos</string>
  <string>velocity</string>
  <string>contains</string>
  <string>stamp_contains</string>
</list>
<string name="filename">entity.def</string>
<int name="lineno">2</int>

admin_entity

All classes and objects used for adminitrativive purposes

  • parent: root_entity
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>description</string>
</list>
<string name="filename">entity.def</string>
<int name="lineno">95</int>

account

Base class for accounts

  • parent: admin_entity
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>description</string>
  <string>username</string>
  <string>password</string>
  <string>characters</string>
</list>
<string name="filename">entity.def</string>
<int name="lineno">100</int>
admin

Privileged accounts

  • parent: account
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>description</string>
</list>
<string name="filename">entity.def</string>
<int name="lineno">113</int>
player

Player accounts

  • parent: account
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>description</string>
</list>
<string name="filename">entity.def</string>
<int name="lineno">108</int>

game

Games this server hosts

  • parent: admin_entity
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>description</string>
</list>
<string name="filename">entity.def</string>
<int name="lineno">118</int>

game_entity

All In Game classes and objects

  • parent: root_entity
  • specification: atlas_game
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>specification</string>
  <string>interface</string>
  <string>description</string>
</list>
<string name="filename">entity.def</string>
<int name="lineno">123</int>

geometry

Base for all geometry related map elements

  • parent: game_entity
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>description</string>
</list>
<string name="filename">map.def</string>
<int name="lineno">2</int>
area

Some kind 2D area

  • parent: geometry
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>description</string>
</list>
<string name="filename">map.def</string>
<int name="lineno">7</int>
2D_grid

Basically container for "Terrain Exception Data in AMIS".

  • parent: area
  • name: some area
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>name</string>
  <string>description</string>
  <string>cell_size</string>
  <string>grid_size</string>
  <string>grid_data</string>
  <string>example</string>
</list>
<string name="filename">map.def</string>
<int name="lineno">28</int>
= hilly =

Defining hilly type first

                  (here could be for example movement_speed 
                   attribute too for example)
  • parent: 2D_grid
  • name: Hilly part around Eluryh lake
  • specification: example
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>specification</string>
  <string>name</string>
  <string>description</string>
  <string>parents</string>
  <string>children</string>
  <string>media</string>
  <string>cell_size</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">35</int>
== hilly1 ==

Specific hilly instances: note missing place where there is lake

  • parent: hilly
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>description</string>
  <string>parents</string>
  <string>children</string>
  <string>loc</string>
  <string>pos</string>
  <string>media</string>
  <string>grid_size</string>
  <string>grid_data</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">46</int>
== hilly2 ==
  • parent: hilly
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>description</string>
  <string>loc</string>
  <string>pos</string>
  <string>media</string>
  <string>grid_size</string>
  <string>grid_data</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">72</int>
== hilly3 ==
  • parent: hilly
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>description</string>
  <string>loc</string>
  <string>pos</string>
  <string>media</string>
  <string>grid_size</string>
  <string>grid_data</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">86</int>
= lake =

Defining lake type

  • parent: 2D_grid
  • name: Lake
  • specification: example
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>specification</string>
  <string>name</string>
  <string>description</string>
  <string>parents</string>
  <string>children</string>
  <string>media</string>
  <string>cell_size</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">211</int>
== lake1 ==

One lake

  • parent: lake
  • name: Eluryh
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>name</string>
  <string>description</string>
  <string>parents</string>
  <string>children</string>
  <string>loc</string>
  <string>pos</string>
  <string>media</string>
  <string>grid_size</string>
  <string>grid_data</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">220</int>
= plain =

Defining plain type

  • parent: 2D_grid
  • name: Plains
  • specification: example
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>specification</string>
  <string>name</string>
  <string>description</string>
  <string>parents</string>
  <string>children</string>
  <string>media</string>
  <string>cell_size</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">103</int>
== plain1 ==

Specific plains

  • parent: plain
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>description</string>
  <string>loc</string>
  <string>pos</string>
  <string>media</string>
  <string>grid_size</string>
  <string>grid_data</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">112</int>
== plain2 ==
  • parent: plain
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>description</string>
  <string>loc</string>
  <string>pos</string>
  <string>media</string>
  <string>grid_size</string>
  <string>grid_data</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">160</int>
== plain3 ==
  • parent: plain
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>description</string>
  <string>loc</string>
  <string>pos</string>
  <string>media</string>
  <string>grid_size</string>
  <string>grid_data</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">174</int>
== plain4 ==
  • parent: plain
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>description</string>
  <string>loc</string>
  <string>pos</string>
  <string>media</string>
  <string>grid_size</string>
  <string>grid_data</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">188</int>
= river =

Defining river type

  • parent: 2D_grid
  • name: River
  • specification: example
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>specification</string>
  <string>name</string>
  <string>description</string>
  <string>parents</string>
  <string>children</string>
  <string>media</string>
  <string>cell_size</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">244</int>
== river1 ==

Few rivers

  • parent: river
  • name: Hardonar river
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>name</string>
  <string>description</string>
  <string>parents</string>
  <string>children</string>
  <string>loc</string>
  <string>pos</string>
  <string>media</string>
  <string>width</string>
  <string>line_data</string>
  <string>grid_size</string>
  <string>grid_data</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">253</int>
== river2 ==

connects to lake

  • parent: river
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>description</string>
  <string>loc</string>
  <string>pos</string>
  <string>media</string>
  <string>width</string>
  <string>line_data</string>
  <string>grid_size</string>
  <string>grid_data</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">303</int>
= road_block =

Defining road types

  • parent: 2D_grid
  • name: Road block
  • specification: example
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>specification</string>
  <string>name</string>
  <string>description</string>
  <string>parents</string>
  <string>children</string>
  <string>media</string>
  <string>cell_size</string>
  <string>width</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">333</int>
== bridge ==

Defining bridge type

  • parent: road_block
  • name: Bridge
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>name</string>
  <string>description</string>
  <string>parents</string>
  <string>children</string>
  <string>media</string>
  <string>cell_size</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">343</int>
=== bridge1 ===

Actual bridge

  • parent: bridge
  • name: Murray bridge
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>description</string>
  <string>parents</string>
  <string>children</string>
  <string>name</string>
  <string>loc</string>
  <string>pos</string>
  <string>media</string>
  <string>line_data</string>
  <string>grid_size</string>
  <string>grid_data</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">405</int>
== road1 ==

Actual road

  • parent: road_block
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>description</string>
  <string>parents</string>
  <string>children</string>
  <string>loc</string>
  <string>pos</string>
  <string>media</string>
  <string>line_data</string>
  <string>grid_size</string>
  <string>grid_data</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">359</int>
== road2 ==

Actual road

  • parent: road_block
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>description</string>
  <string>parents</string>
  <string>children</string>
  <string>loc</string>
  <string>pos</string>
  <string>media</string>
  <string>line_data</string>
  <string>grid_size</string>
  <string>grid_data</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">376</int>
== road3 ==

Actual road

  • parent: road_block
  • name: Murdar road
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>description</string>
  <string>parents</string>
  <string>children</string>
  <string>loc</string>
  <string>pos</string>
  <string>media</string>
  <string>line_data</string>
  <string>grid_size</string>
  <string>grid_data</string>
  <string>name</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">423</int>
agrilan

This is whole agrilan map: at coords only height is guessed and because this is toplevel now, there is no ref attribute in location

Hand made example map based on http://www.worldforge.org/images/maps/map_agrilan_4_us.jpg

No media id's here though, except few example...

First ascii map: origin: -80,-40

HHLHRPAP
HLLRRRPA
HHLHHRPA
PPPPPRPA 
PPPPPPRA
FFFPPAAA

Legend:
H=Hilly
L=Lake
R=River
A=roAd
P=Plains
F=Forest


  • parent: area
  • specification: example
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>specification</string>
  <string>description</string>
  <string>long_description</string>
  <string>pos</string>
  <string>contains</string>
  <string>media</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">2</int>
agrilan_lands

All agrilan lands

  • parent: area
  • specification: example
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>specification</string>
  <string>description</string>
  <string>parents</string>
  <string>children</string>
  <string>pos</string>
  <string>contains</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">457</int>
agrilan_waters

All Agrilan waters container

  • parent: area
  • specification: example
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>specification</string>
  <string>description</string>
  <string>parents</string>
  <string>children</string>
  <string>loc</string>
  <string>pos</string>
  <string>contains</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">324</int>
line

Some kind line

  • parent: geometry
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>parents</string>
  <string>children</string>
  <string>description</string>
  <string>width</string>
  <string>line_data</string>
  <string>example</string>
</list>
<string name="filename">map.def</string>
<int name="lineno">12</int>
road

Collection of road blocks

  • parent: line
  • name: Road
  • specification: example
  • members:
<list name="attribute_order">
  <string>id</string>
  <string>specification</string>
  <string>name</string>
  <string>description</string>
  <string>parents</string>
  <string>children</string>
  <string>media</string>
</list>
<string name="filename">agrilan_map.def</string>
<int name="lineno">351</int>
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox