Class SetTMPTextEffector

Change the TMP text of the given Text object. TextMeshPro is required to work

Inheritance
object
AFunction
AEffector
AUnityEffector
SetTMPTextEffector
Inherited Members
Namespace: Xareus.Scenarios.Unity
Assembly: Xareus.Unity.Libraries.dll
Syntax
[FunctionDescription("Effector to change the TMP text of the given Text object. TextMeshPro is required to work", new string[] { "Unity/Text" })]
public class SetTMPTextEffector : AUnityEffector

Constructors

SetTMPTextEffector(Event, Dictionary<string, Parameter>, ContextHolder)

Declaration
protected SetTMPTextEffector(Event @event, Dictionary<string, Parameter> parameters, ContextHolder contexts)
Parameters
Type Name Description
Event event
Dictionary<string, Parameter> parameters
ContextHolder contexts

Fields

text

Declaration
[ConfigurationParameter("Text", Necessity.Required, Description = "If both text and textAsset are specified, textAsset will prevail")]
protected string text
Field Value
Type Description
string

textAsset

Declaration
[ConfigurationParameter("TextAsset", Necessity.Optional, Description = "If both text and textAsset are specified, textAsset will prevail")]
protected TextAsset textAsset
Field Value
Type Description
TextAsset

textObject

Declaration
[ConfigurationParameter("Text Object", Necessity.Required)]
protected TMP_Text textObject
Field Value
Type Description
TMP_Text

Methods

SafeEffectorUpdate()

Actual effector code. Note that this code will be executed in unity's thread

Declaration
public override void SafeEffectorUpdate()
Overrides