Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
Close Submission failedFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
Close Your name Your email Suggestion* Declarationpublic static void
SetPropertyModifications(
Object targetPrefab, PropertyModification[]
modifications);
Parameters Parameter Description targetPrefab A reference to the Prefab instance to be modified. Although the type and name imply an asset, it is the outermost instance as a GameObject that should be provided. modifications A set of PropertyModification objects that define the changes to the target Prefab instance. DescriptionAssigns a set of PropertyModification objects to a target Prefab instance relative to its source Prefab Asset.
It's important to provide this method with the top-level object in the target instance's branch of the hierarchy to avoid unexpected results. Use GetOutermostPrefabInstanceRoot for this purpose.
PropertyModification fields for Prefab overrides:
value
fieldThe PropertyModification members always expected to have been set are the target
object the modification applies to (i.e. a persistent Prefab asset object reference), the propertyPath
of the property to be modified and its new value
or objectReference
, as shown in the following example:
The following example shows an example of PropertyModification.objectReference
usage on a Prefab which has a MeshRenderer:
Be aware that calls to SetPropertyModifications
will replace the previous set of modifications. If the intention is to accumulate modifications, then retrieve the current set with GetPropertyModifications and include them in the new set.
SetPropertyModifications can be used to remove unwanted modifications. To remove only non-default modifications, filter them away and keep the default overrides, as below:
For creating overrides a preferred approach is to use either RecordPrefabInstancePropertyModifications for manually changed properties or use SerializedObject and SerializedProperty which will automatically generate overrides.
For applying and reverting overrides consider using the following API which provide convenient access to Apply and Revert functionality:
GetObjectOverrides GetAddedComponents GetRemovedComponents GetAddedGameObjects GetRemovedGameObjects.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4