Table of Contents

Parameter types

TMPEffects supports a variety of different parameter types that come with built-in parsing utilities (see the next section).

Supported types

This is the full list of currently supported parameter types:

Type formatting

This is an overview of how to correctly format the different parameter types in your tags, most with at least one example.

  • float: Must use . as decimal, not ,
    • 2.54, 3
  • int: Just a plain integer number
    • 12
  • bool: Either true or false
  • Color: Colors may be defined either in HEX format, HSV format or RGB(A) format. In addition to that, there are a bunch of supported keywords
    • #DEADBEEF,hsv(0.3,64,52), rgb(0,0.5,0.5), indigo
  • Vector2: Two bracketed floats, separated by comma
    • (0.3, 22.4)
  • Vector3: Three bracketed floats, separated by comma (or two; third float automatically set to zero)
    • (0.3, 22.4, 0) = (0.3, 22.4)
  • Vector2Offset: Same as Vector2, but with leading o:
    • o:(0.3, 22.4)
  • Vector2Offset: Same as Vector3, but with leading o:
    • (0.3, 22.4, 0) = o:(0.3, 22.4)
  • Anchor: Same as Vector2, but with leading a:
    • a:(0.3, 22.4)
  • TypedVector2: Format of either Vector2, Vector2Offset or Anchor
    • (0.3, 22.4), o:(0.3, 22.4), a:(0.3, 22.4)
  • TypedVector3: Format of either Vector3, Vector3Offset or Anchor
    • (0.3, 22.4, 0), o:(0.3, 22.4, 0), a:(0.3, 22.4)
  • AnimationCurve: Generally keywords; though you may also construct custom curves by specifying one of the predefined methods (cubic, quadratic, linear) or just a raw vector sequence. See AnimationCurveUtility for more info.
    • easinoutsine, quadratic((0,0),(0.2,0.7),(1,1)), (0,0),(0.2,0.7),(1,1)
  • WaveOffsetType: Keywords
    • index / idx, segmentindex / sindex / sidx, x / xpos, y / ypos
  • Array: Multiple of the desired type, separated by a semicolon
    • 0.3;4.82;1, red;green;blue, true;false;false
Edit this page