TargeterDefinitionSpline

Inheritance 1 ancestor · 9 siblings

TargeterDefinition
- TargeterDefinitionAoe
- TargeterDefinitionArc
- TargeterDefinitionCone
- TargeterDefinitionLine
- TargeterDefinitionMinimap
- TargeterDefinitionMultiAOE
- TargeterDefinitionRange
- TargeterDefinitionSkipTerrain
- TargeterDefinitionSplinecurrent
- TargeterDefinitionWall

Class Documentation

A targeting indicator that draws a curved ribbon from startLocator to endLocator, along a spline. The client builds the spline from the two positions with overrideSpline, or with the spline of the spell's missile movement if overrideSpline is not set; HermiteSplineInfo describes the curve. The end is moved to the height of the start.

The ribbon is splineWidth wide. With L the length of the spline:

If L is greater than the width, the base texture covers the first L - width of the ribbon and the front texture covers the last piece, as long as the width.
Otherwise the front texture covers the whole ribbon.

The client cuts the ribbon into segments of length min(L / minSegmentCount, maxSegmentLength).

Properties

baseTextureName

File = "0x0"

Type history (2 revisions)

13.15 - 16.16 String
since 16.17 File

Documentation Edit documentation

Texture of the body of the ribbon. If it is empty, the LineRangeLocalBase texture of SharedTargeterResources applies.

constraintRange

Embed<FloatPerSpellLevel> = { "mValueType": 0, "mPerLevelValues": [0, 0, 0, 0, 0, 0] }

Documentation Edit documentation

Largest distance from start to end, in world units, read only with isConstrainedToRange.

endLocator

Embed<DrawablePositionLocator>

Default value

{
  "orientationType": 0,
  "basePosition": 0,
  "angleOffsetRadian": 0,
  "distanceOffset": 0
}

Documentation Edit documentation

End of the spline. Its height is replaced by the height of the start.

frontTextureName

File = "0x0"

Type history (2 revisions)

13.15 - 16.16 String
since 16.17 File

Documentation Edit documentation

Texture of the front piece. If it is empty, the LineRangeLocalTarget texture of SharedTargeterResources applies.

isConstrainedToRange

Bool = false

Documentation Edit documentation

Keeps the end within constraintRange of the start.

maxSegmentLength

F32 = 50

Documentation Edit documentation

Longest segment of the ribbon, in world units.

minSegmentCount

U32 = 10

Documentation Edit documentation

Smallest number of segments of the ribbon. The client uses more segments when L / minSegmentCount is longer than maxSegmentLength.

overrideSpline

Pointer<ISplineInfo> = null

Documentation Edit documentation

The spline parameters. If it is not set, the client takes the spline of the spell's missile movement, such as GenericSplineMovementSpec.mSplineInfo.

splineWidth

Embed<FloatPerSpellLevel> = { "mValueType": 0, "mPerLevelValues": [0, 0, 0, 0, 0, 0] }

Documentation Edit documentation

Width of the ribbon and length of its front piece, in world units. If it is unset, the spell's mLineWidth applies.

startLocator

Embed<DrawablePositionLocator>

Default value

{
  "orientationType": 0,
  "basePosition": 0,
  "angleOffsetRadian": 0,
  "distanceOffset": 0
}