Command reference
Foragable
Command words: foragable
Permission: Admin
This command is used to view and edit foragables. Foragables are records of item or commodity results that can be loaded by the forage command. Item outputs need an item prototype; commodity outputs need a material, optional tag, and weight expression. The foragable must be linked to a foragable profile before players can find it. A single foragable can be shared between multiple profiles.
The types on a foragable must match the yield names on the profile where you link it. For example, a foragable with type wood can be found by forage wood anywhere that profile has a wood yield.
You can use the following options with this command:
foragable list [+key, -key] - shows all the foragables
foragable show <which> - shows a foragable
foragable edit <which> - opens a revision of a foragable
foragable edit new - creates a new foragable
foragable edit - an alias for foragable show on an opened foragable
foragable edit close - closes the currently edited foragable
foragable edit submit - submits the foragable for review
foragable edit delete - deletes a non-approved revision
foragable edit obsolete - marks a foragable as obsolete
foragable review all|mine|<which> - opens a foragable for review
foragable review list - shows all the foragables due to review
foragable review history <which> - shows the history of a foragable
foragable set name <name> - renames this foragable
foragable set proto <which> - sets the proto for this foragable to load and clears commodity output
foragable set commodity material <material> [tag <tag>|notag] weight <weight> - switches this foragable to commodity output
foragable set commodity clear - clears commodity output
foragable set material <which> - sets the commodity material and clears item prototype output
foragable set tag <which> - sets the commodity tag
foragable set tag none - clears the commodity tag
foragable set weight <weight> - sets a fixed commodity weight
foragable set weight variable <expression> - sets a variable commodity weight expression with outcome available
foragable set chance <#> - the relative weight of this option being found
foragable set quantity <# or dice> - a number or dice expression for the item quantity found
foragable set difficulty <difficulty> - the difficulty that the result is evaluated against for this output
foragable set outcome <min> <max> - the minimum and maximum check outcome that this item can appear on
foragable set types <type1> [<type2>] ... [<typen>] - sets the yield types that this foragable appears against
foragable set canforage <prog> - sets a prog that controls whether this foragable can be found
foragable set canforage clear - clears the can-forage prog
foragable set onforage <prog> - sets a prog that will run when this item is foraged
foragable set onforage clear - clears the on-forage prog
The full list of search filters is as follows:
all - includes obsolete and non-current revisions
mine - only shows things you personally created
by <account> - only shows things the nominated account created
reviewed <account> - only shows things the nominated account has approved
+<keyword> - only shows things with the nominated keyword
-<keyword> - excludes things with the nominated keyword
Permission: Admin
This command is used to view and edit foragables. Foragables are records of item or commodity results that can be loaded by the forage command. Item outputs need an item prototype; commodity outputs need a material, optional tag, and weight expression. The foragable must be linked to a foragable profile before players can find it. A single foragable can be shared between multiple profiles.
The types on a foragable must match the yield names on the profile where you link it. For example, a foragable with type wood can be found by forage wood anywhere that profile has a wood yield.
You can use the following options with this command:
foragable list [+key, -key] - shows all the foragables
foragable show <which> - shows a foragable
foragable edit <which> - opens a revision of a foragable
foragable edit new - creates a new foragable
foragable edit - an alias for foragable show on an opened foragable
foragable edit close - closes the currently edited foragable
foragable edit submit - submits the foragable for review
foragable edit delete - deletes a non-approved revision
foragable edit obsolete - marks a foragable as obsolete
foragable review all|mine|<which> - opens a foragable for review
foragable review list - shows all the foragables due to review
foragable review history <which> - shows the history of a foragable
foragable set name <name> - renames this foragable
foragable set proto <which> - sets the proto for this foragable to load and clears commodity output
foragable set commodity material <material> [tag <tag>|notag] weight <weight> - switches this foragable to commodity output
foragable set commodity clear - clears commodity output
foragable set material <which> - sets the commodity material and clears item prototype output
foragable set tag <which> - sets the commodity tag
foragable set tag none - clears the commodity tag
foragable set weight <weight> - sets a fixed commodity weight
foragable set weight variable <expression> - sets a variable commodity weight expression with outcome available
foragable set chance <#> - the relative weight of this option being found
foragable set quantity <# or dice> - a number or dice expression for the item quantity found
foragable set difficulty <difficulty> - the difficulty that the result is evaluated against for this output
foragable set outcome <min> <max> - the minimum and maximum check outcome that this item can appear on
foragable set types <type1> [<type2>] ... [<typen>] - sets the yield types that this foragable appears against
foragable set canforage <prog> - sets a prog that controls whether this foragable can be found
foragable set canforage clear - clears the can-forage prog
foragable set onforage <prog> - sets a prog that will run when this item is foraged
foragable set onforage clear - clears the on-forage prog
The full list of search filters is as follows:
all - includes obsolete and non-current revisions
mine - only shows things you personally created
by <account> - only shows things the nominated account created
reviewed <account> - only shows things the nominated account has approved
+<keyword> - only shows things with the nominated keyword
-<keyword> - excludes things with the nominated keyword