Effect

Info

• typeClass

• namespaceAnimatext

Constructors

• Effect(params BaseEffect[] presets)

  • presetsThe presets of the effect.

Properties

Public

• autoEndboolEnds automatically when the effect is completed to play in the play state.

• autoPlayboolPlays automatically when the effect is in the start state.

• autoStartboolStarts automatically when the effect is updated or refreshed in the stop state.

• autoStopboolStops automatically when the effect is in the end state.

• refreshModeRefreshModeThe refresh mode of the effect. Refresh mode determines the state of the effect after the refresh.

• speedfloatThe speed of the effect.

• stateEffectStateThe state of the effect.

• timefloatThe playing time of the effect.

Events

Public

• onEndSystem.ActionThe event triggered when the effect ends.

• onPauseSystem.ActionThe event triggered when the effect pauses.

• onPlaySystem.ActionThe event triggered when the effect plays.

• onProceedSystem.ActionThe event triggered when the waiting time of all the preset tag ranges is less than or equal to the effect time for the first time.

• onStartSystem.ActionThe event triggered when the effect starts.

• onStopSystem.ActionThe event triggered when the effect stops.

Methods

Public

• End()Ends the effect.

• Execute()Executes the text animations of the effect.

• ExtraExecute()Extra executes the text animations of the effect. This method is called when the text animations are executed again in the same frame.

• GetInfoFlags()InfoFlagsGets info flags of the effect.

• GetTags()HashSet<string>Gets the tags of the effect.

• Pause()Pauses the effect.

• Play()Plays the effect.

• Refresh()Refreshes the effect.

• Start()Starts the effect.

• Stop()Stops the effect.

• Update(TextInfo textInfo, BaseAnimatext component)Updates the effect info.