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

Modify Unit. More...

#include <Effect.h>

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

Public Attributes

SEffectWhichUnit TransferUnit
 Transfer Unit. More...
 
SEffectWhichUnit LaunchUnit
 Launch Unit. More...
 
SEffectWhichUnit ImpactUnit
 Impact Unit. More...
 
SEffectWhichUnit KillCreditUnit
 Kill Credit Unit. More...
 
flag8 KillHallucination
 Kill Hallucination. More...
 
SEffectModifyUnitCost Cost
 Cost. More...
 
std::vector< SEffectModifyVitalVitalArray
 Vitals. More...
 
CFixed Height
 Height. More...
 
CGameTime HeightTime
 Height Time. More...
 
CFlags ModifyFlags
 Modification Flags. More...
 
CFixed XP
 Experience. More...
 
uint32 ResourceRestoreBonus
 Resource Restore Bonus. More...
 
CFixed ResourceRestoreFraction
 Resource Restore Fraction. More...
 
int32 Resources
 Resources. More...
 
uint32 ResourcesHarvestedBonus
 Resources Harvested Bonus. More...
 
CFixed ResourcesHarvestedFraction
 Resources Harvested Fraction. More...
 
SCostFactor SalvageFactor
 Salvage Factor. More...
 
int32 SpawnCount
 Spawn Count. More...
 
uint32 CopyOrderCount
 Copy Order Count. More...
 
uint32 CopyRallyCount
 Copy Rally Count. More...
 
SEffectWhichPlayer ModifyOwnerPlayer
 Modify Owner Player. More...
 

Detailed Description

Modify Unit.

Remarks
Unknown

Member Data Documentation

◆ CopyOrderCount

uint32 CEffectModifyUnit::CopyOrderCount

Copy Order Count.

Specifies how many orders of the Launch Unit are copied onto the Impact Unit. The Impact Unit’s orders are cleared (although uninterruptible orders like morphs may remain until completed).

Remarks
maxValue:

◆ CopyRallyCount

uint32 CEffectModifyUnit::CopyRallyCount

Copy Rally Count.

Specifies how many rally point locations are copied from the Launch Unit to the Impact Unit.

Remarks
maxValue:

◆ Cost

SEffectModifyUnitCost CEffectModifyUnit::Cost

Cost.

Specifies an amount of resources, cooldowns, charges, and/or vitals that will be applied to the requested Impact Unit. This can be used in situations where you may not have an ability available to specify and spend these amounts.

◆ Height

CFixed CEffectModifyUnit::Height

Height.

Height modification

◆ HeightTime

CGameTime CEffectModifyUnit::HeightTime

Height Time.

Amount of time it takes to blend the height modification

Remarks
minValue: 0

◆ ImpactUnit

SEffectWhichUnit CEffectModifyUnit::ImpactUnit

Impact Unit.

The unit that is the target of this effect

◆ KillCreditUnit

SEffectWhichUnit CEffectModifyUnit::KillCreditUnit

Kill Credit Unit.

If this field points to a valid unit hostile to the Impact Unit, it will increase the kill count on the Impact Unit by one and dispatch a kill credit notification to behaviors.

◆ KillHallucination

flag8 CEffectModifyUnit::KillHallucination

Kill Hallucination.

When enabled, the effect kills hallucinations.

Remarks
minValue: 0
maxValue: 0

◆ LaunchUnit

SEffectWhichUnit CEffectModifyUnit::LaunchUnit

Launch Unit.

Specifies the unit to copy veterancy, kills, and vitals (if requested), mimic (if requested), copy orders from (if requested), copy rally points from (if requested), and the player to modify resources for (if requested).

◆ ModifyFlags

CFlags CEffectModifyUnit::ModifyFlags

Modification Flags.

Flags for the effect

Remarks
indexEnum: EEffectModify

◆ ModifyOwnerPlayer

SEffectWhichPlayer CEffectModifyUnit::ModifyOwnerPlayer

Modify Owner Player.

Specifies a player to transfer the ownership of the Impact Unit to. If set to Unknown this is ignored.

◆ ResourceRestoreBonus

uint32 CEffectModifyUnit::ResourceRestoreBonus

Resource Restore Bonus.

Specifies a flat bonus amount to add to a resource regardless of its capacity. This will be added to the Resource Restore Fraction result.

◆ ResourceRestoreFraction

CFixed CEffectModifyUnit::ResourceRestoreFraction

Resource Restore Fraction.

Specifies a fraction that will be multiplied by the resource’s capacity. This will be added to the Resource Restore Bonus.

Remarks
minValue: 0

◆ Resources

int32 CEffectModifyUnit::Resources

Resources.

Specifies an amount of resources to harvest from the Launch Unit if it has a resource behavior.

◆ ResourcesHarvestedBonus

uint32 CEffectModifyUnit::ResourcesHarvestedBonus

Resources Harvested Bonus.

Specifies an amount of bonus resources added to any amount extracted from the resource specified by the Resources behavior and the Resources Harvested Fraction result.

◆ ResourcesHarvestedFraction

CFixed CEffectModifyUnit::ResourcesHarvestedFraction

Resources Harvested Fraction.

Specifies an amount that is multiplied by the amount extracted to grant as a bonus amount of resources harvested. This amount is added to the Resources Harvested Bonus.

Remarks
minValue: 0

◆ SalvageFactor

SCostFactor CEffectModifyUnit::SalvageFactor

Salvage Factor.

Only applies if the Salvage flag is set on this effect. Specifies the unit cost multiplier to determine how much of a refund is provided.

◆ SpawnCount

int32 CEffectModifyUnit::SpawnCount

Spawn Count.

If the Impact Unit has a Spawn behavior, the number of spawned units will be adjusted by this amount.

◆ TransferUnit

SEffectWhichUnit CEffectModifyUnit::TransferUnit

Transfer Unit.

◆ VitalArray

std::vector<SEffectModifyVital> CEffectModifyUnit::VitalArray

Vitals.

Vital modifiers

Remarks
indexEnum: EUnitVital

◆ XP

CFixed CEffectModifyUnit::XP

Experience.

Experience points modifier


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