Can be used to provide global values that do not need to be passed in as arguments when formatting a string.
The smart string should take the format {groupName.variableName}. e.g {global.player-score}.
Note: The group name and variable names must not contain any spaces.
Inheritance
GlobalVariablesSource
[Serializable]
public class GlobalVariablesSource : ISource, IDictionary<string, GlobalVariablesGroup>, ICollection<KeyValuePair<string, GlobalVariablesGroup>>, IEnumerable<KeyValuePair<string, GlobalVariablesGroup>>, IEnumerable, ISerializationCallbackReceiver
Constructors
Declaration
public GlobalVariablesSource(SmartFormatter formatter)
Parameters
Properties
Declaration
public int Count { get; }
Property Value
Declaration
public bool IsReadOnly { get; }
Property Value
Has BeginUpdating() been called?
This can be used when updating the value of multiple IGlobalVariable in order to do
a single update after the updates instead of 1 per change.
Declaration
public static bool IsUpdating { get; }
Property Value
Declaration
public GlobalVariablesGroup this[string name] { get; set; }
Parameters
| Type |
Name |
Description |
| String |
name |
|
Property Value
Declaration
public ICollection<string> Keys { get; }
Property Value
Declaration
public ICollection<GlobalVariablesGroup> Values { get; }
Property Value
Methods
Declaration
public void Add(KeyValuePair<string, GlobalVariablesGroup> item)
Parameters
Declaration
public void Add(string name, GlobalVariablesGroup group)
Parameters
Declaration
public static void BeginUpdating()
Declaration
Declaration
public bool Contains(KeyValuePair<string, GlobalVariablesGroup> item)
Parameters
Returns
Declaration
public bool ContainsKey(string name)
Parameters
| Type |
Name |
Description |
| String |
name |
|
Returns
Declaration
public void CopyTo(KeyValuePair<string, GlobalVariablesGroup>[] array, int arrayIndex)
Parameters
Declaration
public static void EndUpdating()
Declaration
public IEnumerator GetEnumerator()
Returns
Declaration
public void OnAfterDeserialize()
Implements
Declaration
public void OnBeforeSerialize()
Implements
Declaration
public bool Remove(KeyValuePair<string, GlobalVariablesGroup> item)
Parameters
Returns
Declaration
public bool Remove(string name)
Parameters
| Type |
Name |
Description |
| String |
name |
|
Returns
Declaration
public bool TryEvaluateSelector(ISelectorInfo selectorInfo)
Parameters
Returns
Implements
Declaration
public bool TryGetValue(string name, out GlobalVariablesGroup value)
Parameters
Returns
Declaration
public static IDisposable UpdateScope()
Returns
Events
Called after the final EndUpdating() has been called.
This can be used when you wish to respond to value change events but wish to do a
single update at the end instead of 1 per change.
For example, if you wanted to change the value of multiple global variables
that a smart string was using then changing each value would result in a new string
being generated, by using begin and end the string generation can be deferred until the
final change so that only 1 update is performed.
Declaration
public static event Action EndUpdate
Event Type
Extension Methods
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.