User Tools
Sidebar
smithbox:param-editor-massedit-reference
Table of Contents
Mass Edit Reference
A basic mass edit command is comprised of three selectors and an operation.
A more advanced mass edit command can instead perform a row operation.
Selection in each category can be controlled more precisely by using the && characters to combine multiple selection criteria.
Row and field operations can make use of operation arguments, which return a value that can then be operated on.
Variables can be used to hold a value.
Param Selectors
| Usage | Description |
|---|---|
| selection | Selects the current param selection and selected rows in that param. |
| clipboard | Selects the param of the clipboard and the rows in the clipboard. |
| param | Selects all params whose name matches the given regex. |
| modified | Selects params where any rows do not match the vanilla version, or where any are added. Ignores row names. |
| auxparam: <parambank> | Selects params from the specified regulation or parambnd where the param name matches the given regex. |
| vars: <string> | Selects variables whose name matches the given regex. |
Row Selectors
| Usage | Description |
|---|---|
| selection | Selects the current param selection and selected rows in that param. |
| clipboard | Selects the param of the clipboard and the rows in the clipboard. |
| modified | Selects rows which do not match the vanilla version, or are added. Ignores row name. |
| added | Selects rows where the ID is not found in the vanilla param. |
| id: <string> | Selects rows whose ID matches the given regex. |
| idrange: <min> <max> | Selects rows whose ID falls in the given numerical range. Minimum and maximum are inclusive. |
| name: <string> | Selects rows whose Name matches the given regex. |
| prop: <string> <value> | Selects rows where the specified field has a value that matches the given regex. |
| proprange: <string> <min> <max> | Selects rows where the specified field has a value that falls in the given numerical range. Minimum and maximum are inclusive. |
| propref: <field> <name> | Selects rows where the specified field that references another param has a value referencing a row whose name matches the given regex. |
| propwhere: <field> <selector> | Selects rows where the specified field appears when the given cell or field search is given |
| mergeable | Selects rows which are not modified in the primary regulation or parambnd and there is exactly one equivalent row in another regulation or parambnd that is modified. |
| conflicts | Selects rows which, among all equivalents in the primary and additional regulations or parambnds, there is more than 1 row which is modified |
| fmg: <string> | Selects rows which have an attached FMG and that FMG's text matches the given regex. |
| vanillaprop: <field> <value> | Selects rows where the vanilla equivilent of that row has a value for the given field that matches the given regex |
| vanillaproprange: <string> <min> <max> | Selects rows where the vanilla equivilent of that row has a value for the given field that falls in the given numerical range |
| auxprop: <parambank> <field> <value> | Selects rows where the equivilent of that row in the given regulation or parambnd has a value for the given field that matches the given regex. Can be used to determine if an aux row exists. |
| auxproprange: <parambank> <field> <min> <max> | Selects rows where the equivilent of that row in the given regulation or parambnd has a value for the given field that falls in the given range |
| semijoin: <field> <parambank> <field> <row selector> | Selects all rows where the value of a given field is any of the values in the second given field found in the given param using the given row selector. |
| unique: <field> | Selects all rows where the value in the given field is unique. |
| vars: <string> | Selects variables whose name matches the given regex. |
Field Selectors
| Usage | Description |
|---|---|
| <field> | Selects cells/fields where the internal name of that field matches the given regex. |
| modified | Selects cells/fields where the equivalent cell in the vanilla regulation or parambnd has a different value |
| auxmodified: <parambank> | Selects cells/fields where the equivalent cell in the specified regulation or parambnd has a different value. |
| sftype: <type> | Selects cells/fields where the field's data type, as enumerated by SoulsFormats, matches the given regex. |
| vars: <string> | Selects variables whose name matches the given regex. |
Global Operations
| Usage | Description |
|---|---|
| clear | Clears clipboard param and rows. |
| newvar <name> <value> | Creates a variable with the given value, and the type of that value. |
| clearvars | Deletes all variables. |
Operation Arguments
| Usage | Description |
|---|---|
| self | Gives the value of the currently selected value. |
| field <field> | Gives the value of the given cell/field for the currently selected row and param |
| vanilla | Gives the value of the equivalent cell/field in the vanilla regulation or parambnd for the currently selected cell/field, row and param. Will fail if a row does not have a vanilla equivalent. |
| aux <parambank> | Gives the value of the equivalent cell/field in the specified regulation or parambnd for the currently selected cell/field, row and param. Will fail if a row does not have a aux equivalent. Consider using && !added |
| vanillafield <field> | Gives the value of the specified cell/field in the vanilla regulation or parambnd for the currently selected cell/field, row and param. Will fail if a row does not have a vanilla equivalent. Consider using && !added |
| auxfield <parambank> <field> | Gives the value of the specified cell/field in the aux regulation or parambnd for the currently selected cell/field, row and param. Will fail if a row does not have an aux equivilent. |
| paramlookup <param> <row> <field> | Returns the specific value specified by the exact param, row and field. |
| average <field> <row selector> | Gives the mean value of the cells/fields found using the given selector, for the currently selected param. |
| median <field> <row selector> | Gives the median value of the cells/fields found using the given selector, for the currently selected param |
| mode <field> <row selector> | Gives the mode value of the cells/fields found using the given selector, for the currently selected param. |
| min <field> <row selector> | Gives the smallest value of the cells/fields found using the given selector, for the currently selected param. |
| max <field> <row selector> | Gives the largest value of the cells/fields found using the given selector, for the currently selected param |
| random <min> <max> | Gives a random decimal number between the given values for each selected value. Minimum and maximum are inclusive. |
| randint <min> <max> | Gives a random integer number between the given values for each selected value. Minimum and maximum are inclusive. |
| randFrom <param> <field> <row selector> | Gives a random value from the cells/fields found using the given param, row selector and field, for each selected value. |
| paramIndex | Gives an integer for the current selected param, beginning at 0 and increasing by 1 for each param selected. |
| rowIndex | Gives an integer for the current selected row, beginning at 0 and increasing by 1 for each row selected. |
| fieldIndex | Gives an integer for the current selected field, beginning at 0 and increasing by 1 for each field selected. |
Row Operations
| Usage | Description |
|---|---|
| copy | Adds the selected rows into clipboard. If the clipboard param is different, the clipboard is emptied first. |
| copyN <value> | Adds the selected rows into clipboard the given number of times. If the clipboard param is different, the clipboard is emptied first |
| paste | Adds the selected rows to the primary regulation or parambnd in the selected param |
Field Operations
| = <value> | Assigns the given value to the selected values. Will attempt conversion to the value's data type. |
| + <value> | Adds the number to the selected values, or appends text if that is the data type of the values. |
| - <value> | Subtracts the number from the selected values. |
| * <value> | Multiplies selected values by the number. |
| / <value> | Divides the selected values by the number |
| % <value> | Gives the remainder when the selected values are divided by the number. |
| scale <factor> <center> | Multiplies the difference between the selected values and the center number by the factor number. |
| replace <search string> <replace string> | Interprets the selected values as text and replaces all occurances of the text to replace with the new text |
| replacex <search string> <replace string> | Interprets the selected values as text and replaces all occurances of the given regex with the replacement, supporting regex groups |
| max <value> | Returns the larger of the current value and number. |
| min <value> | Returns the smaller of the current value and number. |
| round <value> | Rounds the current value to the specified number of decimals. |
| ceil <value> | Rounds the current value up to the closest integer. |
| floor <value> | Rounds the current value down to the closest integer. |
smithbox/param-editor-massedit-reference.txt · Last modified: by admin
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
