... {!SHARED_OBJECT_CATEGORY;<ID>;<CATEGORY>}
Add shared object `<ID>` to category `<CATEGORY>`. You may add a single object to as many categories
as you like. By default this template is auto-inserted by the specialized `!SHARED_OBJECT` variants
with the category being the name of the raw tag the template replaces.
The category information may then be queried by scripts, or if you know what you are doing, it is possible
to use templates. For example `@FOREACH_LIST` with the master key `Libs/Base:!SHARED_OBJECT_CATEGORY:<ID>`
will allow you to iterate all object in a category. You will probably want to use `@IF` with `@READ_TABLE`
and `@PARSE_TO` to make sure the object has not been invalidated since it was added.
Example:
# Print the names of all inorganics.
{E;{@FOREACH_LIST;Libs/Base:!SHARED_OBJECT_CATEGORY:INORGANIC;
{@PARSE_TO;TEMP;{@READ_TABLE;Libs/Base:!SHARED_OBJECT_CATEGORY:INORGANIC;%val}
}{@IF;$TEMP;t;"\t%{val}\n"}
}}
# Check if IRON is an inorganic.
{@PARSE_TO;TEMP;{@READ_TABLE;Libs/Base:!SHARED_OBJECT_CATEGORY:INORGANIC;IRON}
}{@IF;$TEMP;t;IRON is an inorganic!;IRON is not an inorganic!}
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
... {!SHARED_OBJECT_DUPLICATE;<OLD_ID>;<NEW_ID>;[<EDIT_RAWS>=true]}
Duplicate shared object `<OLD_ID>` using the name `<NEW_ID>`. Shared object `<OLD_ID>` must exist,
make sure this is evaluated *after* that object! If a shared object with the ID `<NEW_ID>` already
exists this does nothing (so addons may override each other).
Setting `<EDIT_RAWS>` to anything other than `true` will make this template not try to fix the raws,
which may lead to duplicate raw objects!
The raw fixer is kinda simple minded, but it should work in common cases. The raw fixer simply changes
the first parameter of the first raw tag to the new ID. If you need to do something complicated it is
better to set `<EDIT_RAWS>` to false and fix the raws yourself (using a script or clever use of
`SHARED_OBJECT_REPLACE_TAG` and other similar templates).
Generally it is better to use a custom template to create multiple similar objects, but this is nice
to have when working with objects from other addons.
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
{SHARED_OBJECT_MERGE;<ID>;<RULES>;<SOURCE>}
Apply rule-based changes to the shared object with `<ID>`.
This one is hard to explain without an example, so here you go:
{!SHARED_OBJECT;TEST;[FOO:BAR:BAZ]}
{SHARED_OBJECT_MERGE;TEST;$:?:&;[FOO:BAZ:BAR]}
Result:
[FOO:BAZ:BAZ]
Documentation of the rule format is in [Rubble Basics](/doc/Rubble%20Basics#MergeRules).
... {@FOREACH;<ITEMS>;<RAWS>;[<SEPA=|>;[<SEPB>==]]}
Repeats `<RAWS>` once for each pair of items in `<ITEMS>`. `<ITEMS>` must be a specially formated string.
`<SEPA>` and `<SEPB>` **must not** be the same string! If they are, or if `<ITEMS>` is malformed, then
the output may not be what you are expecting!
`<ITEMS>` format example:
key1=value1|key2=value2|...|keyn=valuen
Each item is stripped of leading and trailing whitespace, if an item is quoted the quotes are stripped and
any escape sequences are expanded (just like template parameters).
`<RAWS>` is treated like a user template body that has the parameters `key` and `val` defined.
Example:
{@FOREACH;a=1|b=2|c=3;"\"%{key}\" = %{val},\n"}
Output:
"a" = 1,
"b" = 2,
"c" = 3,
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
{@PARSE_TO;<ID>;<RAWS>}
Parse `<RAWS>` and store the result to the configuration variable `<ID>`.
This is useful because most templates will expand variables in their parameters, but they won't
parse other templates unless the parameter is supposed to be raw text. By using this template you can
circumvent this limitation to do weird and wonderful things (it almost makes the template language
into a proper scripting language! Well, maybe not).
Example:
{@PARSE_TO;TEMP;{@READ_TABLE;Libs/Base:!SHARED_OBJECT_CATEGORY:INORGANIC;IRON}
}{@IF;$TEMP;t;IRON is an inorganic!;IRON is not an inorganic!}
Author
Topic: Rubble 8.5.5 - DF 44.7 - New DF, new Rubble. (Read 71263 times)