Class LocalizeStringEvent
Component that can be used to Localize a string. Allows for configuring optional string arguments and provides an update event that can be used to update the string.
Namespace: UnityEngine.Localization.Components
Syntax
public class LocalizeStringEvent : MonoBehaviour
Properties
OnUpdateString
Event that will be sent when the localized string is ready.
Declaration
public LocalizeStringEvent.StringUnityEvent OnUpdateString { get; set; }
Property Value
Type | Description |
---|---|
LocalizeStringEvent.StringUnityEvent |
StringReference
References the StringTable and StringTableEntry of the localized string.
Declaration
public LocalizedString StringReference { get; set; }
Property Value
Type | Description |
---|---|
LocalizedString |
Methods
OnDisable()
Stops listening for changes to StringReference.
Declaration
protected virtual void OnDisable()
OnEnable()
Starts listening for changes to StringReference.
Declaration
protected virtual void OnEnable()
UpdateString(String)
Invokes the OnUpdateString event.
Declaration
protected virtual void UpdateString(string value)
Parameters
Type | Name | Description |
---|---|---|
String | value |