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

Iterate Transport. More...

#include <Effect.h>

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

Public Attributes

SEffectWhichUnit WhichUnit
 Unit. More...
 
CTargetFilters SearchFilters
 Search Filters. More...
 
uint32 MaxCount
 Maximum Count. More...
 
CEffectLink Effect
 Effect. More...
 
flag8 CheckOuter
 Check Outer. More...
 

Detailed Description

Iterate Transport.

Remarks
Unknown

Member Data Documentation

◆ CheckOuter

flag8 CEffectEnumTransport::CheckOuter

Check Outer.

Requests that the search be performed against whatever unit contains the “Which Unit”. This is useful if you have an effect attached to the Marine in a bunker but you want to find other units in the same bunker and you can’t easily get access to the bunker itself (which is marine’s container or outer unit).

◆ Effect

CEffectLink CEffectEnumTransport::Effect

Effect.

Specifies an effect to execute on all units in the transport that match the requested Search Filters.

◆ MaxCount

uint32 CEffectEnumTransport::MaxCount

Maximum Count.

Specifies the maximum number of units to apply the effect to. If this value is 0 then the effect will apply to all units in the transport that pass the Search Filters.

◆ SearchFilters

CTargetFilters CEffectEnumTransport::SearchFilters

Search Filters.

Specifies a set of requirements and exclusions to apply against each unit in a transport. Only units that pass the filters will have effects applied to them.

◆ WhichUnit

SEffectWhichUnit CEffectEnumTransport::WhichUnit

Unit.

Specifies the transport or passenger to search. If you specify a passenger, make sure that the Check Outer field is also enabled on this effect so it can find other units in the transport that contains the initial passenger.


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