CGameEffect<Effect> Classes¶
Overview¶
Note
There are lots of game effect classes that are similar in definition. Rather than document each one individually, there are all referenced here collectively instead. CGameEffect<Effect> classes handle specific effects, where <Effect> is a placeholder for the game effect name.
Note
Please see the CGameEffect Structures section for a game effect structure used by a specific game effect class.
Tip
See Notes for details of the game effect classes, that the class methods documented here apply to. See Specific CGameEffect<Effect> Classes for classes that share the same methods as the others listed, but have additional class methods as well.
Methods¶
Name* |
Description |
Constructor for a specific game effect |
|
Apply effect |
|
Copy effect |
* <Effect> is a placeholder for the game effect name
CGameEffect<Effect>::CGameEffect<Effect>¶
Constructs a specific game effect object
void CGameEffect<Effect>::CGameEffect<Effect>(
Item_effect_st* effect,
CPoint& source,
long sourceID,
CPoint target);
Parameters
Item_effect_st* effect -
CPoint& source -
longsourceID -CPoint target -
Remarks
Constructor for a specific game effect. See Notes for the specific class names this applies to.
Example: CGameEffectEntangle::CGameEffectEntangle(effect,source,sourceID,target);
CGameEffect<Effect>::ApplyEffect¶
virtual int CGameEffect<Effect>::ApplyEffect(CGameSprite* pSprite);
Parameters
CGameSprite* pSprite - pointer to game sprite object
Return Value
Returns int
Remarks
See Notes for the specific class names this applies to.
Example: virtual int CGameEffectEntangle::ApplyEffect(CGameSprite* pSprite);
CGameEffect<Effect>::Copy¶
Copy game effect
virtual CGameEffect* CGameEffect<Effect>::Copy();
Return Value
Returns CGameEffect*
Remarks
See Notes for the specific class names this applies to.
Example: virtual CGameEffect* CGameEffectEntangle::Copy();
Notes¶
Note
CGameEffect<Effect> used in the documentation above is a placeholder for the actual class name, as listed below.
The following class names apply to the documented class methods above as the share the same basic methods and a constructor for each class:
Specific CGameEffect<Effect> Classes¶
Note
The following class names also apply to the above documentation, but also contain additional class methods. They are listed here as well for completeness as they share the same basic class methods, but they are documented individually as well due to the additional class methods they contain - see the specific class for details.
- CGameEffectAlignmentReversal Class
- CGameEffectAnimationChange Class
- CGameEffectApplyEffect Class
- CGameEffectBase Class
- CGameEffectBlindness Class
- CGameEffectBounceLevelDecrement Class
- CGameEffectCharm Class
- CGameEffectColorGlowSolid Class
- CGameEffectCurseApplyEffect Class
- CGameEffectDamage Class
- CGameEffectDeath Class
- CGameEffectDisease Class
- CGameEffectDoNotDraw Class
- CGameEffectFile Class
- CGameEffectHeal Class
- CGameEffectHitPoints Class
- CGameEffectHoldCreatureSpell Class
- CGameEffectImmunityLevelDecrement Class
- CGameEffectImmunityToEffect Class
- CGameEffectList Class
- CGameEffectMakeUnselectable Class
- CGameEffectMaze Class
- CGameEffectOverrideAnimation Class
- CGameEffectPoison Class
- CGameEffectPolymorph Class
- CGameEffectPortrait Class
- CGameEffectPowerWordSleep Class
- CGameEffectPowerWordStun Class
- CGameEffectPushPull Class
- CGameEffectRegeneration Class
- CGameEffectSevenEyes Class
- CGameEffectSexChange Class
- CGameEffectStaticCharge Class
- CGameEffectStoneSkins Class
- CGameEffectStoneSkinsGolem Class
- CGameEffectSummon Class