Mercurial > hg > batmud > ggrtf
changeset 1375:714675602c72
Comments and documentation added for alchemist module.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Tue, 29 Mar 2011 14:39:37 +0300 |
parents | 191114d8a356 |
children | 3d73752368ae |
files | gm-alchemist.tf |
diffstat | 1 files changed, 31 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/gm-alchemist.tf Sun Mar 27 01:20:39 2011 +0200 +++ b/gm-alchemist.tf Tue Mar 29 14:39:37 2011 +0300 @@ -13,7 +13,7 @@ ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; General settings and data ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -/eval /set galch_file=%{HOME}/public_html/alch/results.txt +/eval /set galch_file=%{HOME}/alch_results.txt /set galch_cans=\ @@ -71,6 +71,10 @@ /shift%;\ /done + +;@command /dolabels +;@desc Automatically re-label any jars and cans you have, to match the +;@desc naming scheme of GgrTF Alchemist module for those containers. /def -i dolabels =\ /galch_label jar %{galch_jars}%;\ /galch_label can %{galch_cans} @@ -96,6 +100,12 @@ /else /return {1}%;/endif +;@command /mix <mineral> <organ> <herb> +;@desc Mix a potion from given materials. This command will automatically +;@desc retrieve organ and herb components from their specific containers. +;@desc The other logic in the module will also return them into those containers +;@desc if the skill is interrupted for some reason. +;@desc Also, organ and herb names are checked for sanity. /def -i mix =\ /if ({#} < 3)\ /msq Usage: /mix <mineral> <organ> <herb>%;\ @@ -143,6 +153,11 @@ @@use mix potion at prepared flask use %{alch_mineral} %{alch_organ} %{_herb} +;@command /tmix <mineral> <organ> <herb> +;@desc Same as /mix, will mix a potion from given materials, but also +;@desc performs functions for potion research. Finished potion will be +;@desc submitted to authenticator, so only use this command when you +;@desc are doing potion research and reside in the authenticator room of the alchemist guild. /def -i tmix =\ /if (alch_testing)\ /msq Previous test still running.%;\ @@ -153,6 +168,9 @@ /endif +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; Helper functions +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; /def -i galch_get_organ =\ /if (alch_st)\ /set alch_hasorgan=1%;\ @@ -249,6 +267,9 @@ /set alch_close=1 +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; Herb and organ management helpers +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; Store organ into proper can /def -i galch_store_organ =\ /let _organ=%{1}%;\ @@ -285,7 +306,10 @@ /endif -;; Automatically look into a container containing specified type of herb or organ +;@command /wconlook <herb or organ name> +;@desc Automatically look into a container containing specified type of herb or organ. +;@desc This is basically the same as 'look at jar x' or 'look at can y', except +;@desc "/wconlook blueberry" would automatically look into the correct container. /def -i wconlook =\ /let _item=$[galch_herb_fixes({*})]%;\ /let _cont=$(/galch_get_item %{_item} %{galch_jars})%;\ @@ -332,8 +356,13 @@ /endif%;\ /endif +;@command /wconput <herb or organ> +;@desc Place specified herb or organ into correct container. /def -i wconput = /galch_container_cmd put in %{*} /prdefgbind -s"wput" -c"/wconput" + +;@command /wconget <herb or organ> +;@desc Get specified herb or organ from correct container. /def -i wconget = /galch_container_cmd get from %{*} /prdefgbind -s"wget" -c"/wconget"