sc2-gamedata
Public Attributes | List of all members
CEffectTeleport Class Reference

Teleport. More...

#include <Effect.h>

Inheritance diagram for CEffectTeleport:
Inheritance graph
[legend]
Collaboration diagram for CEffectTeleport:
Collaboration graph
[legend]

Public Attributes

SEffectWhichUnit WhichUnit
 Unit. More...
 
flag8 ClearQueuedOrders
 Clear Order Queue. More...
 
CFixed MinDistance
 Minimum Distance. More...
 
CFangleArc PlacementArc
 Placement Arc. More...
 
SEffectWhichLocation PlacementAround
 Placement Around. More...
 
CFixed PlacementRange
 Placement Range. More...
 
CFixed Range
 Range. More...
 
SEffectWhichLocation SourceLocation
 Source. More...
 
SEffectWhichLocation TargetLocation
 Target. More...
 
CFlags TeleportFlags
 Teleport Flags. More...
 

Detailed Description

Teleport.

Remarks
Unknown

Member Data Documentation

◆ ClearQueuedOrders

flag8 CEffectTeleport::ClearQueuedOrders

Clear Order Queue.

When enabled, the effect clears all previous orders from the unit's order queue

◆ MinDistance

CFixed CEffectTeleport::MinDistance

Minimum Distance.

Specifies the smallest distance permissible for a teleport. Helps to avoid spending energy or cooldowns on a teleport that doesn’t get you closer to your target by a reasonable amount.

◆ PlacementArc

CFangleArc CEffectTeleport::PlacementArc

Placement Arc.

Only used if the Placement Range is less than 363. Specifies an arc around the teleporting unit that it will attempt to search to find a valid location.

Remarks
minValue: 0
maxValue: 0

◆ PlacementAround

SEffectWhichLocation CEffectTeleport::PlacementAround

Placement Around.

Only used if the Placement Range is less than 363. Specifies a location to do placement tests for the teleporting unit.

◆ PlacementRange

CFixed CEffectTeleport::PlacementRange

Placement Range.

The range from the target point that a teleporting unit can be placed if the target point is invalid

Remarks
minValue: 0
maxValue: 0

◆ Range

CFixed CEffectTeleport::Range

Range.

Teleport range

Remarks
minValue: 0
maxValue: 0

◆ SourceLocation

SEffectWhichLocation CEffectTeleport::SourceLocation

Source.

Specifies the origin of the teleport. This would typically be used where you want to perform a relative teleport like Recall. The teleporting unit’s offset relative to that location would be preserved as closely as possible at the destination.

◆ TargetLocation

SEffectWhichLocation CEffectTeleport::TargetLocation

Target.

Used to configure the target location for the teleport

◆ TeleportFlags

CFlags CEffectTeleport::TeleportFlags

Teleport Flags.

Remarks
indexEnum: EEffectTeleport

◆ WhichUnit

SEffectWhichUnit CEffectTeleport::WhichUnit

Unit.

Used to configure which unit will teleport


The documentation for this class was generated from the following file: