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

Create Unit. More...

#include <Effect.h>

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

Public Attributes

SEffectWhichLocation WhichLocation
 Location. More...
 
SEffectWhichLocation Origin
 Origin. More...
 
CFlags CreateFlags
 Creation Options. More...
 
SEffectWhichUnit RallyUnit
 Rally Unit. More...
 
SEffectWhichPlayer SpawnOwner
 Spawn Owner. More...
 
CEffectLink SpawnEffect
 Effect - Spawn. More...
 
CUnitLink SpawnUnit
 Spawn Unit. More...
 
uint32 SpawnCount
 Spawn Count. More...
 
CFixed SpawnRange
 Spawn Range. More...
 
std::vector< CGamePointSpawnOffset
 Spawn Offset. More...
 
SEffectWhichUnit SelectUnit
 Select Unit. More...
 
SEffectWhichUnit TypeFallbackUnit
 Type Fallback Unit. More...
 

Detailed Description

Create Unit.

Remarks
Unknown

Member Data Documentation

◆ CreateFlags

CFlags CEffectCreateUnit::CreateFlags

Creation Options.

Flags for the effect

Remarks
indexEnum: ECreateUnit

◆ Origin

SEffectWhichLocation CEffectCreateUnit::Origin

Origin.

Origin position at which to create a unit.

◆ RallyUnit

SEffectWhichUnit CEffectCreateUnit::RallyUnit

Rally Unit.

Identifies a unit whose rally instructions are copied and issued to the created unit.

◆ SelectUnit

SEffectWhichUnit CEffectCreateUnit::SelectUnit

Select Unit.

If this resolves to a unit and that unit is selected, then the newly created unit will also be selected. The created unit may also be added to control groups if the Select Control Groups create flag is set.

◆ SpawnCount

uint32 CEffectCreateUnit::SpawnCount

Spawn Count.

Number of units spawned

Remarks
minValue: 1

◆ SpawnEffect

CEffectLink CEffectCreateUnit::SpawnEffect

Effect - Spawn.

Effect that runs on each of the spawned units

◆ SpawnOffset

std::vector<CGamePoint> CEffectCreateUnit::SpawnOffset

Spawn Offset.

Specifies a set of X,Y offsets relative to the effect location (specified by the Which Location field). The effect will use the closest offset that the unit can be spawned from to position the new unit when it is created.

◆ SpawnOwner

SEffectWhichPlayer CEffectCreateUnit::SpawnOwner

Spawn Owner.

Owner of the spawned unit

◆ SpawnRange

CFixed CEffectCreateUnit::SpawnRange

Spawn Range.

Maximum distance away from the effect that a unit can be created.

Remarks
minValue: 0
maxValue: 0

◆ SpawnUnit

CUnitLink CEffectCreateUnit::SpawnUnit

Spawn Unit.

Unit that spawns

◆ TypeFallbackUnit

SEffectWhichUnit CEffectCreateUnit::TypeFallbackUnit

Type Fallback Unit.

If the Spawn Unit is not setup, this field may specify another unit in the effect tree whose type will be used to create the new unit.

◆ WhichLocation

SEffectWhichLocation CEffectCreateUnit::WhichLocation

Location.

Location where the effect occurs


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