Atlas Type Reference - Operations II
From WorldForgeWiki
Contents
get
Generic operation for getting info about things.
- parent: action
- specification file:
<list name="attribute_order"> <string>id</string> <string>parents</string> <string>children</string> <string>description</string> <string>args_description</string> <string>example</string> </list> <string name="filename">operation.def</string> <int name="lineno">89</int>
- examples:
<map> <string name="objtype">op</string> <list name="parents"> <string>get</string> </list> <list name="args"> <map> <string name="id">elf_type_id_45</string> <map name="specification_file"> <list name="attribute_order"> <string>id</string> </list> <string name="filename">operation.def</string> <int name="lineno">99</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">95</int> </map> </map> <string><h4>Browsing operator hierarchy example:</h4> <p> First start from operator hierarchy root (root_operation):</string> <map> <string name="objtype">op</string> <list name="parents"> <string>get</string> </list> <list name="args"> <map> <string name="id">root_operation</string> <map name="specification_file"> <list name="attribute_order"> <string>id</string> </list> <string name="filename">operation.def</string> <int name="lineno">108</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">104</int> </map> </map> <string>Answer might be:</string> <map> <string name="objtype">op</string> <list name="parents"> <string>info</string> </list> <list name="args"> <map> <string name="id">root_operation</string> <list name="children"> <string>action</string> <string>info</string> </list> <string name="description">Base operator for all operatios</string> <map name="specification_file"> <list name="attribute_order"> <string>id</string> <string>children</string> <string>description</string> </list> <string name="filename">operation.def</string> <int name="lineno">115</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">111</int> </map> </map> <string>Then you can ask about action and info:</string> <map> <string name="objtype">op</string> <list name="parents"> <string>get</string> </list> <list name="args"> <map> <string name="id">action</string> <map name="specification_file"> <list name="attribute_order"> <string>id</string> </list> <string name="filename">operation.def</string> <int name="lineno">124</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">120</int> </map> </map> <map> <string name="objtype">op</string> <list name="parents"> <string>get</string> </list> <list name="args"> <map> <string name="id">info</string> <map name="specification_file"> <list name="attribute_order"> <string>id</string> </list> <string name="filename">operation.def</string> <int name="lineno">130</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">126</int> </map> </map> <string>Etc...</string>
login
Operation for logging into server
For more about <a href="login.html">out of game atlas here</a>
- parent: get
- specification file:
<list name="attribute_order"> <string>id</string> <string>parents</string> <string>children</string> <string>description</string> <string>long_description</string> <string>args_description</string> <string>example</string> </list> <string name="filename">operation.def</string> <int name="lineno">313</int>
- examples:
<map> <string name="objtype">op</string> <list name="parents"> <string>login</string> </list> <list name="args"> <map> <string name="id">JoeBlatz</string> <string name="password">Rqv67.%</string> <map name="specification_file"> <list name="attribute_order"> <string>id</string> <string>password</string> </list> <string name="filename">operation.def</string> <int name="lineno">324</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">320</int> </map> </map> <string>Conversation examples:<br> When you connect to server you either need to have account already or make one. Here is "start by creating account" -example:</string> <map> <string name="objtype">op</string> <list name="parents"> <string>create</string> </list> <int name="serialno">1</int> <list name="args"> <map> <string name="id">player74</string> <list name="parents"> <string>player</string> </list> <string name="password">player_password</string> <map name="specification_file"> <list name="attribute_order"> <string>id</string> <string>parents</string> <string>password</string> </list> <string name="filename">operation.def</string> <int name="lineno">335</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>serialno</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">330</int> </map> </map> <string>What if you already had account by that name? Then reply from server could be something like this (1 argument: message, 2 argument: original operation):</string> <map> <string name="objtype">op</string> <list name="parents"> <string>error</string> </list> <int name="serialno">4</int> <int name="refno">1</int> <float name="seconds">19036033149.3</float> <string name="time_string">0612-01-05 10:59:09.3</string> <list name="args"> <map> <string name="message">Account id already exist</string> <map name="specification_file"> <list name="attribute_order"> <string>message</string> </list> <string name="filename">operation.def</string> <int name="lineno">350</int> </map> </map> <map> <string name="objtype">op</string> <list name="parents"> <string>create</string> </list> <int name="serialno">1</int> <list name="args"> <map> <string name="id">player74</string> <list name="parents"> <string>player</string> </list> <string name="password">player_password</string> <map name="specification_file"> <list name="attribute_order"> <string>id</string> <string>parents</string> <string>password</string> </list> <string name="filename">operation.def</string> <int name="lineno">357</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>serialno</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">352</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>serialno</string> <string>refno</string> <string>seconds</string> <string>time_string</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">342</int> </map> </map> <string>For more about error operation see <a href="#error">error operation definition</a>. <br><br> If account login went OK them you might receive something like:</string> <map> <string name="objtype">op</string> <list name="parents"> <string>info</string> </list> <int name="serialno">2</int> <int name="refno">1</int> <float name="seconds">19036033149.3</float> <string name="time_string">0612-01-05 10:59:09.3</string> <list name="args"> <map> <string name="id">player74</string> <list name="parents"> <string>player</string> </list> <string name="password">player_password</string> <list name="characters"> <string>Bjorn_1</string> </list> <map name="specification_file"> <list name="attribute_order"> <string>id</string> <string>parents</string> <string>password</string> <string>characters</string> </list> <string name="filename">operation.def</string> <int name="lineno">374</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>serialno</string> <string>refno</string> <string>seconds</string> <string>time_string</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">366</int> </map> </map> <string>If you do not have character, then you need to create one. Creating character is similar to how you create account.</string> <map> <string name="objtype">op</string> <list name="parents"> <string>create</string> </list> <int name="serialno">2</int> <list name="args"> <map> <list name="parents"> <string>farmer</string> </list> <string name="name">Nisuf</string> <string name="description">ordinary farmer</string> <string name="e_sex">male</string> <map name="specification_file"> <list name="attribute_order"> <string>parents</string> <string>name</string> <string>description</string> <string>e_sex</string> </list> <string name="filename">operation.def</string> <int name="lineno">387</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>serialno</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">382</int> </map> </map> <string>Result of character creation is same as with account creation, only resulting object differs.</string>
logout
Operation for logging out
- parent: login
- specification file:
<list name="attribute_order"> <string>id</string> <string>parents</string> <string>children</string> <string>description</string> <string>args_description</string> <string>example</string> </list> <string name="filename">operation.def</string> <int name="lineno">395</int>
- examples:
<map> <string name="objtype">op</string> <list name="parents"> <string>logout</string> </list> <list name="args"> <map> <string name="id">JoeBlatz</string> <map name="specification_file"> <list name="attribute_order"> <string>id</string> </list> <string name="filename">operation.def</string> <int name="lineno">405</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">401</int> </map> </map> <string>Most useful with server<->server communication telling that certain connection is not anymore pertinent</string>
perceive
Generic base operation for perceiving things by eyes, ears, etc...
- parent: get
- specification: atlas_game
- specification file:
<list name="attribute_order"> <string>id</string> <string>parents</string> <string>children</string> <string>specification</string> <string>description</string> <string>args_description</string> <string>example</string> </list> <string name="filename">operation.def</string> <int name="lineno">299</int>
- examples:
<map> <string name="objtype">op</string> <list name="parents"> <string>perceive</string> </list> <list name="args"> <map> <string name="id">elf_3545</string> <map name="specification_file"> <list name="attribute_order"> <string>id</string> </list> <string name="filename">operation.def</string> <int name="lineno">310</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">306</int> </map> </map>
listen
Listen (something)
- parent: perceive
- specification file:
<list name="attribute_order"> <string>id</string> <string>parents</string> <string>children</string> <string>description</string> <string>args_description</string> <string>example</string> </list> <string name="filename">operation.def</string> <int name="lineno">773</int>
- examples:
<map> <string name="objtype">op</string> <list name="parents"> <string>listen</string> </list> <list name="args"> <map> <string name="id">elf_3545</string> <map name="specification_file"> <list name="attribute_order"> <string>id</string> </list> <string name="filename">operation.def</string> <int name="lineno">783</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">779</int> </map> </map>
look
Looking at something
- parent: perceive
- specification file:
<list name="attribute_order"> <string>id</string> <string>parents</string> <string>children</string> <string>description</string> <string>args_description</string> <string>example</string> </list> <string name="filename">operation.def</string> <int name="lineno">697</int>
- examples:
<map> <string name="objtype">op</string> <list name="parents"> <string>look</string> </list> <list name="args"> <map> <string name="id">elf_3545</string> <map name="specification_file"> <list name="attribute_order"> <string>id</string> </list> <string name="filename">operation.def</string> <int name="lineno">707</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">703</int> </map> </map> <string>Conversation examples:<br> When you connect to server you need to look to see things. Server sends all new things that appear and all changes that you see (like movement). But it is clients responsibility to make first update of what it sees. Reason is that only client knows what it has cached. <p>First look can have empty argument list: then server sends appropriate top level object for current scheme.</string> <map> <string name="objtype">op</string> <list name="parents"> <string>look</string> </list> <int name="serialno">5</int> <string name="from">Bjorn_10</string> <list name="args"> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>serialno</string> <string>from</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">718</int> </map> </map> <string>Server reply:</string> <map> <string name="objtype">op</string> <list name="parents"> <string>set</string> <string>sight</string> </list> <int name="serialno">100</int> <int name="refno">5</int> <string name="from">Bjorn_10</string> <string name="to">Bjorn_10</string> <float name="seconds">19035667864.4</float> <string name="time_string">0612-01-01 05:31:04.4</string> <list name="args"> <map> <string name="id">world_0</string> <list name="parents"> <string>world</string> </list> <list name="contains"> <string>tavern_2</string> <string>market_3</string> <string>home_4</string> <string>axe_5</string> <string>Nisuf_6</string> <string>Miyora_7</string> <string>home_8</string> <string>smithy_9</string> <string>Bjorn_10</string> </list> <float name="stamp">19035660000.0</float> <list name="pos"> <float>0.0</float> <float>0.0</float> <float>0.0</float> </list> <map name="specification_file"> <list name="attribute_order"> <string>id</string> <string>parents</string> <string>contains</string> <string>stamp</string> <string>pos</string> </list> <string name="filename">operation.def</string> <int name="lineno">735</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>serialno</string> <string>refno</string> <string>from</string> <string>to</string> <string>seconds</string> <string>time_string</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">725</int> </map> </map> <string>Client looks at contains attribute of above object and then looks for those objects in turn:</string> <map> <string name="objtype">op</string> <list name="parents"> <string>look</string> </list> <int name="serialno">6</int> <string name="from">Bjorn_10</string> <list name="args"> <map> <string name="id">Nisuf_6</string> <map name="specification_file"> <list name="attribute_order"> <string>id</string> </list> <string name="filename">operation.def</string> <int name="lineno">749</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>serialno</string> <string>from</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">743</int> </map> </map> <string>And then server tells you more about it:</string> <map> <string name="objtype">op</string> <list name="parents"> <string>set</string> <string>sight</string> </list> <int name="serialno">105</int> <int name="refno">6</int> <string name="from">Nisuf_6</string> <string name="to">Bjorn_10</string> <float name="seconds">19035667864.4</float> <string name="time_string">0612-01-01 05:31:04.4</string> <list name="args"> <map> <string name="id">Nisuf_6</string> <list name="parents"> <string>farmer</string> </list> <float name="e_drunkness">0.0</float> <float name="stamp">19035650000.0</float> <string name="loc">world_0</string> <list name="pos"> <float>20.0</float> <float>50.0</float> <float>300.0</float> </list> <string name="description">ordinary farmer</string> <string name="name">Nisuf</string> <float name="e_status">1.0</float> <map name="specification_file"> <list name="attribute_order"> <string>id</string> <string>parents</string> <string>e_drunkness</string> <string>stamp</string> <string>loc</string> <string>pos</string> <string>description</string> <string>name</string> <string>e_status</string> </list> <string name="filename">operation.def</string> <int name="lineno">762</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>serialno</string> <string>refno</string> <string>from</string> <string>to</string> <string>seconds</string> <string>time_string</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">752</int> </map> </map>
sniff
Sniff something
- parent: perceive
- specification file:
<list name="attribute_order"> <string>id</string> <string>parents</string> <string>children</string> <string>description</string> <string>args_description</string> <string>example</string> </list> <string name="filename">operation.def</string> <int name="lineno">786</int>
- examples:
<map> <string name="objtype">op</string> <list name="parents"> <string>sniff</string> </list> <list name="args"> <map> <string name="id">flower_3545</string> <map name="specification_file"> <list name="attribute_order"> <string>id</string> </list> <string name="filename">operation.def</string> <int name="lineno">796</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">792</int> </map> </map>
touch
Touch something
- parent: perceive
- specification file:
<list name="attribute_order"> <string>id</string> <string>parents</string> <string>children</string> <string>description</string> <string>args_description</string> <string>example</string> </list> <string name="filename">operation.def</string> <int name="lineno">799</int>
- examples:
<map> <string name="objtype">op</string> <list name="parents"> <string>touch</string> </list> <list name="args"> <map> <string name="id">cloth_3545</string> <map name="specification_file"> <list name="attribute_order"> <string>id</string> </list> <string name="filename">operation.def</string> <int name="lineno">809</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">805</int> </map> </map>
imaginary
When something is not yet implemented in server, then character can pretend to do something ;-)
- parent: action
- specification file:
<list name="attribute_order"> <string>id</string> <string>parents</string> <string>children</string> <string>description</string> <string>args_description</string> <string>example</string> </list> <string name="filename">operation.def</string> <int name="lineno">667</int>
- examples:
<map> <string name="objtype">op</string> <list name="parents"> <string>imaginary</string> </list> <list name="args"> <map> <string name="id">some_unimplemented_action</string> <map name="specification_file"> <list name="attribute_order"> <string>id</string> </list> <string name="filename">operation.def</string> <int name="lineno">677</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">673</int> </map> </map>
set
Sets attributes for existing entity.
- parent: action
- specification file:
<list name="attribute_order"> <string>id</string> <string>parents</string> <string>children</string> <string>description</string> <string>example</string> </list> <string name="filename">operation.def</string> <int name="lineno">69</int>
- examples:
<string>This one sets HP=50, height=1.8, width=0.3 for object "9899"</string> <map> <string name="objtype">op</string> <list name="parents"> <string>set</string> </list> <list name="args"> <map> <string name="id">9899</string> <int name="e_HP">50</int> <float name="e_height">1.8</float> <float name="e_width">0.3</float> <map name="specification_file"> <list name="attribute_order"> <string>id</string> <string>e_HP</string> <string>e_height</string> <string>e_width</string> </list> <string name="filename">operation.def</string> <int name="lineno">79</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">75</int> </map> </map>
affect
- parent: set
- specification file:
<list name="attribute_order"> <string>id</string> <string>parents</string> <string>children</string> </list> <string name="filename">operation.def</string> <int name="lineno">85</int>
move
Change position
More about <a href="move.html">movement here</a>
- parent: set
- specification: atlas_game
- specification file:
<list name="attribute_order"> <string>id</string> <string>parents</string> <string>children</string> <string>specification</string> <string>description</string> <string>long_description</string> <string>args_description</string> <string>example</string> </list> <string name="filename">operation.def</string> <int name="lineno">255</int>
- examples:
<string>Movement conversation example:</string> <map> <string name="objtype">op</string> <list name="parents"> <string>move</string> </list> <int name="serialno">123</int> <string name="from">9899</string> <list name="args"> <map> <string name="id">9899</string> <string name="loc">11</string> <list name="pos"> <float>12.3</float> <float>3.0</float> <float>0.0</float> </list> <map name="specification_file"> <list name="attribute_order"> <string>id</string> <string>loc</string> <string>pos</string> </list> <string name="filename">operation.def</string> <int name="lineno">270</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>serialno</string> <string>from</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">264</int> </map> </map> <string>Reply from server</string> <map> <string name="objtype">op</string> <list name="parents"> <string>info</string> <string>sight</string> </list> <int name="serialno">1231</int> <int name="refno">123</int> <string name="from">9899</string> <string name="to">9899</string> <float name="seconds">19036033149.3</float> <string name="time_string">0612-01-05 10:59:09.3</string> <list name="args"> <map> <string name="objtype">op</string> <list name="parents"> <string>set</string> <string>move</string> </list> <int name="serialno">1230</int> <int name="refno">123</int> <string name="from">9899</string> <float name="seconds">19036033149.3</float> <string name="time_string">0612-01-05 10:59:09.3</string> <list name="args"> <map> <string name="id">9899</string> <string name="loc">11</string> <list name="pos"> <float>12.3</float> <float>3.0</float> <float>0.0</float> </list> <map name="specification_file"> <list name="attribute_order"> <string>id</string> <string>loc</string> <string>pos</string> </list> <string name="filename">operation.def</string> <int name="lineno">294</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>serialno</string> <string>refno</string> <string>from</string> <string>seconds</string> <string>time_string</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">285</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>serialno</string> <string>refno</string> <string>from</string> <string>to</string> <string>seconds</string> <string>time_string</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">275</int> </map> </map>
wield
Attach a tool to the character entity at a pre-defined location so that the character can use it.
- parent: set
- specification file:
<list name="attribute_order"> <string>id</string> <string>parents</string> <string>children</string> <string>description</string> <string>args_description</string> </list> <string name="filename">operation.def</string> <int name="lineno">840</int>
use
Use a currently wielded tool.
- parent: action
- specification file:
<list name="attribute_order"> <string>id</string> <string>parents</string> <string>children</string> <string>description</string> <string>args_description</string> </list> <string name="filename">operation.def</string> <int name="lineno">846</int>
info
This is base operator for operations that tell you info about objects or events.
- parent: root_operation
- specification file:
<list name="attribute_order"> <string>id</string> <string>parents</string> <string>children</string> <string>description</string> <string>example</string> </list> <string name="filename">operation.def</string> <int name="lineno">26</int>
- examples:
<map> <string name="objtype">op</string> <list name="parents"> <string>info</string> </list> <list name="args"> <map> <string name="e_msg">Here is some info</string> <map name="specification_file"> <list name="attribute_order"> <string>e_msg</string> </list> <string name="filename">operation.def</string> <int name="lineno">35</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">31</int> </map> </map>
error
Something went wrong
- parent: info
- specification file:
<list name="attribute_order"> <string>id</string> <string>parents</string> <string>children</string> <string>description</string> <string>args_description</string> <string>example</string> </list> <string name="filename">operation.def</string> <int name="lineno">180</int>
- examples:
<string>Client sent "foo" -operation which server rejects</string> <map> <string name="objtype">op</string> <list name="parents"> <string>error</string> </list> <int name="refno">123</int> <list name="args"> <map> <string name="message">Uknown operation foo</string> <map name="specification_file"> <list name="attribute_order"> <string>message</string> </list> <string name="filename">operation.def</string> <int name="lineno">194</int> </map> </map> <map> <string name="objtype">op</string> <list name="parents"> <string>foo</string> </list> <int name="serialno">123</int> <list name="args"> <map> <string name="e_bar">do some foo thing by using bar</string> <map name="specification_file"> <list name="attribute_order"> <string>e_bar</string> </list> <string name="filename">operation.def</string> <int name="lineno">201</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>serialno</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">196</int> </map> </map> </list> <map name="specification_file"> <list name="attribute_order"> <string>objtype</string> <string>parents</string> <string>refno</string> <string>args</string> </list> <string name="filename">operation.def</string> <int name="lineno">189</int> </map> </map>