Version

menu_open

Batch Rename View

The Batch Rename view, seen below, can be prompted by selecting it in the Views menu or using its shortcut (Ctrl+F2 by default). It consists of a Settings (left side) and a Preview (right side) panel. Any editable objects from explorers, like the List View or the Project Explorer, can be dragged over to the Preview panel for renaming.

The Settings panel is where you enter your search and replace patterns. It consists of two primary columns:

  • Name, on the left, identifies the option.

  • Value, on the right, gives the entry.

The following table provides details on these options.

Interface Element

Description

Opens a search field where standard alphanumeric entries filter out unmatching elements from the view. Learn more in Using tables.

Click the Close icon to the left of the search icon to close the search field and remove the filter.

[Note]Note

The searches do not include elements in collapsed nodes of the List View, Query Editor, MIDI Keymap Editor, and Reference View.

Right-click the table header to open the Configure Columns dialog where you can specify which columns to display and their order. See Using tables.

Apply To

Specifies the target for the search and potential rename from two list options:

  • Name - Applies the batch rename to the listed objects' names.

  • Notes - Applies the batch rename to the listed objects' notes.

Replace

Enable this option to activate the following replace settings.

Find what

Specifies the text or regular expression pattern to be replaced in the selected objects' names or notes.

Replace with

Specifies the replacement text or regular expression substitution.

Match case

Specifies whether matching is case-sensitive for the Find what text, if Use Regular Expression is disabled.

Use Regular Expression

Specifies whether the Find what and Replace with fields recognize regular expression syntax.

[Note]Note

Wwise uses the ECMAScript regex style detailed in Regular expression reference.

Occurrence

Specifies which matches to replace:

  • First - The first occurrence of the matching text.

  • Last - The last occurrence of the matching text.

  • All - Every occurrence of the matching text.

[Note]Note

This list is not applicable to regular expressions.

Remove

Enable this option to activate the following remove settings.

Count

Specifies the number of characters to be removed. It is possible to enter a value directly in the field or by using the slider (0 to 100 unless a greater value is entered in the field).

At position

Specifies the number of characters to skip before removing. It is possible to enter a value directly in the field or by using the slider.

From

Specifies to remove from either the beginning or the end of the object name or comment.

Insert

Enable this option to activate the following insert settings.

Insert what

Specifies how the To insert field entry is interpreted. There are two options:

  • Text, to insert only the text entered in the To insert field; or

  • Text with numbers, to insert the number defined according to the C++ printf format number pattern, along with any applicable text adjustments. Commonly used number patterns are available in the selector list.

# start at

Specifies the starting number value. The following numbers will increment this value by one for every object listed in the Batch Rename following alphabetical order of the Before column.

To insert

Specifies an entry field to insert the text or the text containing a C++ printf format number pattern.

The selector, which is active only if Insert what is set to Text with numbers, offers the following numerical C++ printf format pre-defined list options:

  • Decimal (d%) - Decimal, base 10, format (0-9)

  • Decimal with zero padding (%02d)- Decimal, base 10, format with a zero padding single digits (00-09)

  • Hexadecimal lower case (%X) - Hexadecimal, base 16, format where values 10 to 15 are represented by lower case letters (0-f)

  • Hexadecimal upper case (%X) - Hexadecimal, base 16, format where values 10 to 15 are represented by upper case letters (0-F)

  • Hexadecimal with zero padding (0x%04X)- Hexadecimal, base 16, format where values 10 to 15 are represented by upper case letters and there is zero padding for up to four characters (0x0000-0x000F)

At position

Specifies the number of characters to skip before the insert.

From

Specifies the character position where the At position starts its count:

  • Beginning - Starts count before the first character of the name or note. For example, an At position of 3 in the object "car engine" would insert the number after the "r", giving "car1 engine".

  • End - Starts count after the last character of the name or note. For example, an At position of 3 in the object "car engine" would insert the number before the "i", giving "car eng1ine".

Resets the above options to their default, empty, state. Use Ctrl+Z to undo a reset.

The Preview panel on the right listing objects that will be included in the batch rename process. To add objects, drag them from a view, such as the Project Explorer, to the Preview panel. Do this while holding Shift to add more objects; otherwise, dragging objects from a view to the Preview panel will replace any objects that are listed there. To remove objects, select them then press Delete or choose Remove from list in their shortcut menu. Other than selecting them all (using Ctrl+A or just manually) and deleting them, click Remove All to clear the Preview panel.

Interface Element

Description

Opens a search field where standard alphanumeric entries filter out unmatching elements from the view. Learn more in Using tables.

Click the Close icon to the left of the search icon to close the search field and remove the filter.

[Note]Note

The searches do not include elements in collapsed nodes of the List View, Query Editor, MIDI Keymap Editor, and Reference View.

Right-click the table header to open the Configure Columns dialog where you can specify which columns to display and their order. See Using tables.

Name

Displays the object name.

[Note]Note

When Apply to is set to Name, the object name is equivalent to the Before column. The Name column is, therefore, only displayed when Apply to is set to Notes.

Before

Displays the unmodified object names or notes.

After

Displays the modified object names or notes.

(Type - Color)

Displays one of three possible colored squares corresponding to the type of message displayed. No square is displayed if there is no message.

Green - Success (Only appears after clicking Rename All.)

Yellow - Warning (Still possible to rename. No Change is the one warning that can appear after renaming.)

Red - Error (Not possible to rename.)

Message

Displays messages of three possible types: success, warning, or error.

Success message:

  • Successfully renamed

Warning messages:

  • No Replace match detected.

  • Insert text does not have a valid printf format number.

  • No change.

Error messages:

  • Resulting name is already used by a sibling object or is otherwise reserved.

  • Resulting name would be blank.

  • File path would exceed system limit of characters.

  • Name would contain invalid characters (<>*?:"/\|%) for this object type.

[Note]Note

If an object has more than one applicable message, only the latest found is displayed.

Summarizes the number of error and warning messages.

Removes all objects from the panel.

Applies the batch rename to all object's in the Preview panel, whether or not they are filtered out of view with the search filter.

[Tip]Tip

Press Ctrl+Z to undo the operation.

When renaming Work Units or Physical Folders, the Source Control Operation dialog opens. You must confirm that you want to proceed with the operation because it is not possible to undo.


Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise