Class TrackedObject
Provides common Property Variant functionality for a Unity object.
You can inherit from this class to create custom object trackers.
This shows how to create a UnityEngine.Localization.PropertyVariants.TrackedObjects to support the component.
[Serializable]
[DisplayName("Audio Source")]
[CustomTrackedObject(typeof(AudioSource), false)]
public class TrackedAudioSource : TrackedObject
{
public override AsyncOperationHandle ApplyLocale(Locale variantLocale, Locale defaultLocale)
{
var audioClipProperty = GetTrackedProperty("m_audioClip");
if (audioClipProperty == null)
return default;
if (audioClipProperty is LocalizedAssetProperty localizedAssetProperty &&
localizedAssetProperty.LocalizedObject is LocalizedAudioClip localizedAudioClip)
{
localizedAudioClip.LocaleOverride = variantLocale;
var loadHandle = localizedAudioClip.LoadAssetAsync();
if (loadHandle.IsDone)
AudioClipLoaded(loadHandle);
else
{
loadHandle.Completed += AudioClipLoaded;
return loadHandle;
}
}
else if (audioClipProperty is UnityObjectProperty localAssetProperty)
{
if (localAssetProperty.GetValue(variantLocale.Identifier, defaultLocale.Identifier, out var clip))
SetAudioClip(clip as AudioClip);
}
return default;
}
void AudioClipLoaded(AsyncOperationHandle<AudioClip> loadHandle)
{
SetAudioClip(loadHandle.Result);
}
void SetAudioClip(AudioClip clip)
{
var source = (AudioSource)Target;
source.Stop();
source.clip = clip;
if (clip != null)
source.Play();
}
public override bool CanTrackProperty(string propertyPath)
{
return propertyPath == "m_audioClip";
}
}
Inheritance
TrackedObject
Syntax
public abstract class TrackedObject : ISerializationCallbackReceiver
Properties
Target
The target that the variants will be applied to.
Declaration
public Object Target { get; set; }
Property Value
TrackedProperties
The tracked properties for this object.
Declaration
public IList<ITrackedProperty> TrackedProperties { get; }
Property Value
Methods
AddTrackedProperty(ITrackedProperty)
Add a tracked property for this object.
Declaration
public virtual void AddTrackedProperty(ITrackedProperty trackedProperty)
Parameters
AddTrackedProperty<T>(String)
Create and add a tracked property for this object.
Declaration
public T AddTrackedProperty<T>(string propertyPath)
where T : ITrackedProperty, new()
Parameters
Type |
Name |
Description |
String |
propertyPath |
|
Returns
Type Parameters
ApplyLocale(Locale, Locale)
Apply the TrackedProperties for variantLocale
.
If a value does not exist for this locale then the value for defaultLocale
is used as a fallback.
Declaration
public abstract AsyncOperationHandle ApplyLocale(Locale variantLocale, Locale defaultLocale)
Parameters
Type |
Name |
Description |
Locale |
variantLocale |
The chosen variant to apply to Target.
|
Locale |
defaultLocale |
The fallback Locale to use when a value does not exist for this variant.
|
Returns
Type |
Description |
AsyncOperationHandle |
|
CanTrackProperty(String)
Can be used to reject certain properties.
Declaration
public virtual bool CanTrackProperty(string propertyPath)
Parameters
Type |
Name |
Description |
String |
propertyPath |
|
Returns
CreateCustomTrackedProperty(String)
Declaration
public virtual ITrackedProperty CreateCustomTrackedProperty(string propertyPath)
Parameters
Type |
Name |
Description |
String |
propertyPath |
|
Returns
GetTrackedProperty(String)
Return the tracked property for the property path.
Declaration
public virtual ITrackedProperty GetTrackedProperty(string propertyPath)
Parameters
Type |
Name |
Description |
String |
propertyPath |
The serialized property path.
|
Returns
GetTrackedProperty<T>(String, Boolean)
Return the tracked property for the property path.
Declaration
public T GetTrackedProperty<T>(string propertyPath, bool create = true)
where T : ITrackedProperty, new()
Parameters
Type |
Name |
Description |
String |
propertyPath |
The serialized property path.
|
Boolean |
create |
Specify whether to create a property if no existing property is found.
|
Returns
Type Parameters
PostApplyTrackedProperties()
Called when the variants have been applied to Target.
Declaration
protected virtual void PostApplyTrackedProperties()
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.