Hi,
Here’s a quick run-through of how the workflow goes.
Checking Out
Generally the workflow is to edit assets as you would normally. This should prompt you to ‘check out’ assets when you modify assets if you have the option “Prompt for Checkout on Asset Modification” selected in Editor Preferences->Loading & Saving->Source Control.
Alternatively you can right-click on an asset and ‘Check Out’ the file from the Content Browser.
When a file is checked out, it is highlighted with a “Tick” in the Content Browser.
Checking In
When you are happy that you have completed a section of work, you should ‘check-in’ the files that you have been working on. To do this you can either:
- Select the files you have been working on in the Content Browser, right click and choose ‘check-in’ (note that you can right-click on a folder to do this as well).
- Choose File->Submit To Source Control… from the menus. This will scan your project for files that need checking in (or adding) to source control.
When you have selected your files to check-in, you will be presented with the Submit Files dialog:
You can then add a description of your changes and commit/check-in the files for others to see.
Syncing
If you want to get changes that other people have made, you can right-click on files or folders in the Content Browser and select “Sync”. Alternatively you can ‘Sync’ using an external program such as P4V. It is recommended that you shut the editor down if you do this however, as it may lock some files for editing while open.
When a file is ‘out of sync’ (i.e. a newer version exists on the Source Control server to the one you have locally) then it is displayed with a “!” in the Content Browser.
Adding
Similar to the Check-Out workflow, you can auto-add new files to source control using the “Add New Files when Modified” option in the preferences. Files that are added appear with a “+” symbol on them in the Content Browser and can also be checked in (as above for files that are checked out).
Deleting
Deleting assets that are already in source control is more complex as they are usually referenced by something else. We try to make this as transparent as possible, but it can be somewhat confusing.
If you select a file in the Content Browser and press “Delete” (or select it from the right-click menu) then you will be presented with the delete dialog. Once you have chosen how to handle the deletion, the file will generally be replaced by a hidden ‘asset’ known as a [Redirector][3]. If you want to clean up the redirectors that are created when deleting assets you can right-click on a folder in the Content Browser and select “Fix Up Redirectors in Folders”.