combodata

Variables

const int	ID
const int	X
const int	Y
const int	Pos
const int	Layer
untyped[]	InitD
int	OriginalTile
int	Frame
int	AClk
int	Tile
int	Script
int	ASpeed
int	Flip
int	Walk
int	Effect
int	Type
int	CSet deprecated
int	CSet2
int	CSet2Flags
int	Frames
int	NextData
int	NextCSet
int	Flag
int	SkipAnimX
int	SkipAnimY
int	AnimFlags
int[]	Attributes
int[]	Attribytes
int[]	Attrishorts
bool[]	Flags
bool[]	GenFlags
int	LiftGFXCombo
int	LiftGFXCSet
int	LiftUnderCombo
int	LiftUnderCSet
int	LiftDamage
int	LiftLevel
int	LiftItem
bool[]	LiftFlags
int	LiftGFXType
int	LiftGFXSprite
int	LiftSFX
int	LiftBreakSprite
int	LiftBreakSFX
int	LiftHeight
int	LiftTime
int	LiftLightRadius
int	LiftLightShape
int	LiftWeaponItem
int	SkipAnim
int	UserFlags
int	NextTimer
const combotrigger[]	Triggers
int	NumTriggers
bool	OnlyGenTriggers
bool[]	TrigFlags deprecated
int[]	TriggerFlags deprecated
bool[]	TrigButton deprecated
int	TrigLevel deprecated
int	TrigItem deprecated
int	TrigTimer deprecated
int	TrigSFX deprecated
int	TrigChange deprecated
int	TrigCSetChange deprecated
int	TrigProximity deprecated
int	TrigLightBeam deprecated
int	TrigCounter deprecated
int	TrigCtrAmount deprecated
int	TrigCooldown deprecated
int	TrigCopycat deprecated
int	TrigSpawnItemPickup deprecated
int	TrigExState deprecated
int	TrigExDoorDir deprecated
int	TrigExDoorIndex deprecated
int	TrigSpawnEnemy deprecated
int	TrigSpawnItem deprecated
int	TrigLevelState deprecated
int	TrigGlobalState deprecated
int	TrigGStateTimer deprecated
int	TrigGenScript deprecated
int	TrigGroup deprecated
int	TrigGroupVal deprecated
int	TrigLItems deprecated
int	TrigDMapLvl deprecated
int	TrigTintR deprecated
int	TrigTintG deprecated
int	TrigTintB deprecated
int	TrigLvlPal deprecated
int	TrigBossPal deprecated
int	TrigQuakeTimer deprecated
int	TrigWavyTimer deprecated
int	TrigSwordJinx deprecated
int	TrigItemJinx deprecated
int	TrigShieldJinx deprecated
int	TrigStun deprecated
int	TrigBunny deprecated
int	TrigPushTime deprecated

Functions

int	PosX() deprecated
int	PosY() deprecated
int	Pos() deprecated
int	Layer() deprecated
combotrigger	GetTrigger(char32[] buf)

Enumerations

enum ComboSolidityBitflags: 🔗 Source

Combo Quadrants used for Combo Solidity and CSet2vMasks.

ComboSolidityBitflags CMB_QUADRANT_UL = 1

ComboSolidityBitflags CMB_QUADRANT_UR = 4

ComboSolidityBitflags CMB_QUADRANT_DL = 2

ComboSolidityBitflags CMB_QUADRANT_DR = 8

ComboSolidityBitflags CMB_QUADRANT_UPLEFT = 1

ComboSolidityBitflags CMB_QUADRANT_UPRIGHT = 4

ComboSolidityBitflags CMB_QUADRANT_DOWNLEFT = 2

ComboSolidityBitflags CMB_QUADRANT_DOWNRIGHT = 8

ComboSolidityBitflags CMB_QUADRANT_LEFTUP = 1

ComboSolidityBitflags CMB_QUADRANT_RIGHTUP = 4

ComboSolidityBitflags CMB_QUADRANT_LEFTDOWN = 2

ComboSolidityBitflags CMB_QUADRANT_RIGHTDOWN = 8

---

enum AnimationBitflags: 🔗 Source

AnimationBitflags AF_FRESH = 1

AnimationBitflags AF_CYCLE = 2

AnimationBitflags AF_CYCLENOCSET = 4

AnimationBitflags AF_TRANSPARENT = 8

AnimationBitflags AF_CYCLEUNDERCOMBO = 16

---

enum ComboGeneralFlag: 🔗 Source

ComboGeneralFlag GENFLAG_HOOKSHOTTABLE = 0

ComboGeneralFlag GENFLAG_SWITCHHOOKABLE = 1

ComboGeneralFlag GENFLAG_MAX = 2

---

Variable descriptions

const int ID 🔗 Source

The combo’s ID.

---

const int X 🔗 Source

Returns the X-coordinate of a combo from a combodata script, from the ‘this->’ pointer as ‘this->X’.

Using this from any other combodata variable is illegal and undefined.

---

const int Y 🔗 Source

Returns the Y-coordinate of a combo from a combodata script, from the ‘this->’ pointer as ‘this->Y’.

Using this from any other combodata variable is illegal and undefined.

---

const int Pos 🔗 Source

Returns the combo screen index of a combo from a combodata script, from the ‘this->’ pointer as ‘this->Pos’.

Using this from any other combodata variable is illegal and undefined.

---

const int Layer 🔗 Source

Returns the layer the combo is on in a combodata script, from the ‘this->’ pointer as ‘this->Layer’.

Using this from any other combodata variable is illegal and undefined.

---

untyped[] InitD 🔗 Source

The 2 InitD values for the combo script.

---

int OriginalTile 🔗 Source

The ‘Original Tile’ of the combo, used as the start of its animation.

---

int Frame 🔗 Source

The current animation frame the combo is on in its animation. Set to 0 to reset to start of animation.

---

int AClk 🔗 Source

The animation clock of the combo. Set to 0 to reset the timer.

---

int Tile 🔗 Source

The tile currently being displayed by the combo. This is automatically overwritten each frame by the engine.

---

int Script 🔗 Source

The combo script that this combo runs.

---

int ASpeed 🔗 Source

The combo animation speed.

---

int Flip 🔗 Source

value TransformationType (FLIP_ or ROT_)

How to flip (or rotate) the combo.

---

int Walk 🔗 Source

value ComboSolidityBitflags (CMB_QUADRANT_)

The solidity bitmask of the combo (same as Screen->ComboS[]).

---

int Effect 🔗 Source

The effect bitmask of the combo (same as Screen->ComboE[]).

---

int Type 🔗 Source

value ComboType (CT_)

---

int CSet 🔗 Source

Deprecated: Use CSet2 instead!

---

int CSet2 🔗 Source

The CSet2 offset for this combo.

---

int CSet2Flags 🔗 Source

Bitwise access to the 4 corners of the cset2 square. TODO: Untested!

---

int Frames 🔗 Source

The number of frames in the combo animation before it loops.

---

int NextData 🔗 Source

If > 0, cycling is enabled for this combo. When the combo’s animation would normally loop, instead the combo will change to the NextData combo. If the AnimFlags AF_CYCLEUNDERCOMBO is set, it overrides this.

---

int NextCSet 🔗 Source

If the AnimFlags AF_CYCLENOCSET and AF_CYCLEUNDERCOMBO are NOT set, the combo will change to this cset when it cycles.

---

int Flag 🔗 Source

value ComboFlag (CF_)

The inherent flag of the combo.

---

int SkipAnimX 🔗 Source

The number of extra tiles to move horizontally between each frame.

---

int SkipAnimY 🔗 Source

The number of extra tiles to move vertically, when the horizontal movement goes past the end of a tile row.

---

int AnimFlags 🔗 Source

value AnimationBitflags (AF_)

The combo’s animation flags.

---

int[] Attributes 🔗 Source

The 4 combo attributes. These have a full range (all zscript values, including decimal). Their effect depends on the combo type.

---

int[] Attribytes 🔗 Source

The 8 combo attribytes. These have a byte-sized range, 0 to 255. Their effect depends on the combo type.

---

int[] Attrishorts 🔗 Source

The 8 combo attrishorts. These have a short-sized range, -32768 to 32767. Their effect depends on the combo type.

---

bool[] Flags 🔗 Source

The combo’s 16 variable flags. Their effect depends on the combo type.

---

bool[] GenFlags 🔗 Source

index ComboGeneralFlag (GENFLAG_)

The combo’s general flags.

---

int LiftGFXCombo 🔗 Source

The GFX combo/cset used to display the object, if ‘Other Combo GFX’ is the GFX mode.

---

int LiftGFXCSet 🔗 Source

The GFX combo/cset used to display the object, if ‘Other Combo GFX’ is the GFX mode.

---

int LiftUnderCombo 🔗 Source

The combo/cset that will be left behind when this combo is lifted.

---

int LiftUnderCSet 🔗 Source

The combo/cset that will be left behind when this combo is lifted.

---

int LiftDamage 🔗 Source

The weapon damage of the thrown object.

---

int LiftLevel 🔗 Source

The minimum lift glove level required to lift this object.

---

int LiftItem 🔗 Source

If > 0, drops this item ID.

---

bool[] LiftFlags 🔗 Source

index ComboLiftFlag (LF_)

The combo lift flags.

---

int LiftGFXType 🔗 Source

What GFX to use to display the lifted object.

---

int LiftGFXSprite 🔗 Source

The GFX sprite used to display the object, if ‘Sprite Data GFX’ is the GFX mode.

---

int LiftSFX 🔗 Source

The SFX played on lifting.

---

int LiftBreakSprite 🔗 Source

The Sprite Data sprite displayed when the object breaks.

---

int LiftBreakSFX 🔗 Source

The SFX played on breaking.

---

int LiftHeight 🔗 Source

The height above the Hero’s head to lift the object.

---

int LiftTime 🔗 Source

The number of frames it takes to lift the object to its full height.

---

int LiftLightRadius 🔗 Source

The radius of light that will be emitted by the lifted weapon.

---

int LiftLightShape 🔗 Source

The LightShape (LIGHT_) the lifted weapon will use, if light is emitted.

---

int LiftWeaponItem 🔗 Source

If >0, the weapon will behave specially based on the provided item ID.

---

int SkipAnim 🔗 Source

Corresponds to ‘A.SkipX’ in the Combo Editor.

---

int UserFlags 🔗 Source

---

int NextTimer 🔗 Source

---

const combotrigger[] Triggers 🔗 Source

The combo’s triggers.

---

int NumTriggers 🔗 Source

The number of triggers the combo has. Writing to this instantly resizes Triggers[].

---

bool OnlyGenTriggers 🔗 Source

If true, don’t allow the combo to trigger via it’s normal trigger methods (ex: bush via slashing)

---

bool[] TrigFlags 🔗 Source

index ComboTriggerFlag (TRIGFLAG_)

The trigger flags of the combo.

Deprecated: Use Triggers[] / combotrigger::Flags[] instead!

---

int[] TriggerFlags 🔗 Source

Deprecated: Use Triggers[] / combotrigger::Flags[] instead!

---

bool[] TrigButton 🔗 Source

Deprecated: Use Triggers[] / combotrigger::Button[] instead!

---

int TrigLevel 🔗 Source

Deprecated: Use Triggers[] / combotrigger::WeaponLevel instead!

---

int TrigItem 🔗 Source

Deprecated: Use Triggers[] / combotrigger::ReqItem instead!

---

int TrigTimer 🔗 Source

Deprecated: Use Triggers[] / combotrigger::Timer instead!

---

int TrigSFX 🔗 Source

The SFX to play when the combo is triggered. If 0, no SFX will be played.

Deprecated: Use Triggers[] / combotrigger::SFX instead!

---

int TrigChange 🔗 Source

The amount the combo will change by when triggered.

Ex. 1 acts as ‘->Next’, -1 acts as ‘->Prev’.

If 0, no change occurs.

Deprecated: Use Triggers[] / combotrigger::ComboChange instead!

---

int TrigCSetChange 🔗 Source

The amount the cset will change by when triggered.

Deprecated: Use Triggers[] / combotrigger::CSetChange instead!

---

int TrigProximity 🔗 Source

Deprecated: Use Triggers[] / combotrigger::Proximity instead!

---

int TrigLightBeam 🔗 Source

The light beam trigger set that (may) trigger this combo.

0 means any beams, 1-32 mean only matching beams.

Related:

• TriggerFlags[TRIGFLAG_LIGHTON] (trigger when hit by matching light)

• TriggerFlags[TRIGFLAG_LIGHTOFF] (trigger when NOT hit by matching light)

Deprecated: Use Triggers[] / combotrigger::LightBeam instead!

---

int TrigCounter 🔗 Source

Deprecated: Use Triggers[] / combotrigger::Counter instead!

---

int TrigCtrAmount 🔗 Source

Deprecated: Use Triggers[] / combotrigger::CounterAmount instead!

---

int TrigCooldown 🔗 Source

The combo’s cooldown between triggers

Deprecated: Use Triggers[] / combotrigger::Cooldown instead!

---

int TrigCopycat 🔗 Source

If > 0, triggering this combo triggers all other combos with matching TrigCopycat.

Deprecated: Use Triggers[] / combotrigger::Copycat instead!

---

int TrigSpawnItemPickup 🔗 Source

value ItemPickupBitflags (IP_)

The item pickup bitflags for the spawned item.

Only these bitflags are used: IP_HOLDUP, IP_TIMEOUT, IP_TRIGGERSECRETS, and IP_ALWAYSGRAB.

Deprecated: Use Triggers[] / combotrigger::SpawnItemPickup instead!

---

int TrigExState 🔗 Source

If > -1, the ExState that the combo is linked to.

Deprecated: Use Triggers[] / combotrigger::ExState instead!

---

int TrigExDoorDir 🔗 Source

If > -1, the direction of ExDoor that the combo is linked to

Deprecated: Use Triggers[] / combotrigger::ExDoorDir instead!

---

int TrigExDoorIndex 🔗 Source

If TrigExDoorDir is > -1, the index of that direction of ExDoor that the combo is linked to.

Deprecated: Use Triggers[] / combotrigger::ExDoorIndex instead!

---

int TrigSpawnEnemy 🔗 Source

If > 0, the enemy ID spawned when the combo is triggered.

Deprecated: Use Triggers[] / combotrigger::SpawnEnemy instead!

---

int TrigSpawnItem 🔗 Source

If > 0, the item ID (or dropset ID) spawned when the combo is triggered.

Deprecated: Use Triggers[] / combotrigger::SpawnItem instead!

---

int TrigLevelState 🔗 Source

The LevelState used for the TRIGFLAG_TRIGLEVELSTATE and TRIGFLAG_LEVELSTATE

flags. 0-31, inclusive.

Deprecated: Use Triggers[] / combotrigger::LevelState instead!

---

int TrigGlobalState 🔗 Source

The GlobalState used for the TRIGFLAG_TRIGGLOBALSTATE and TRIGFLAG_GLOBALSTATE

flags. 0-255, inclusive.

Deprecated: Use Triggers[] / combotrigger::GlobalState instead!

---

int TrigGStateTimer 🔗 Source

If > 0, the global trigger caused by TRIGFLAG_GLOBALSTATE will set to the ‘on’ state with this value as a timer in frames.

If this value is 0, it instead toggles the state as normal.

Deprecated: Use Triggers[] / combotrigger::GStateTimer instead!

---

int TrigGenScript 🔗 Source

When triggered, this generic script will be run in the ‘RunFrozen’ mode.

Deprecated: Use Triggers[] / combotrigger::GenScript instead!

---

int TrigGroup 🔗 Source

The Trigger Group used for the TRIGFLAG_TGROUP_CONTRIB, TRIGFLAG_TGROUP_LESS, and TRIGFLAG_TGROUP_GREATER flags.

0-255, inclusive.

Deprecated: Use Triggers[] / combotrigger::TrigGroup instead!

---

int TrigGroupVal 🔗 Source

The value used for the TRIGFLAG_TGROUP_LESS and TRIGFLAG_TGROUP_GREATER flags.

0-65535, inclusive.

Deprecated: Use Triggers[] / combotrigger::TrigGroupVal instead!

---

int TrigLItems 🔗 Source

‘LI_’ flags used by the TRIGFLAG_LITEM_REQUIRE,TRIGFLAG_LITEM_INV_REQUIRE,TRIGFLAG_LITEM_SET,TRIGFLAG_LITEM_UNSET flags.

Deprecated: Use Triggers[] / combotrigger::LItems instead!

---

int TrigDMapLvl 🔗 Source

The ‘Level’ used by ‘TrigLItems’.

-1 represents the ‘current level’, otherwise a valid dmap level indicates

that level.

Deprecated: Use Triggers[] / combotrigger::DMapLvl instead!

---

int TrigTintR 🔗 Source

When triggered, the palette is tinted on the red channel by this amount. -255 to 255.

-63 to 63 if compat QR “Scripts use 6-bit color (0-63) instead of 8-bit (0-255)” is enabled.

Deprecated: Use Triggers[] / combotrigger::TintR instead!

---

int TrigTintG 🔗 Source

When triggered, the palette is tinted on the green channel by this amount. -255 to 255.

-63 to 63 if compat QR “Scripts use 6-bit color (0-63) instead of 8-bit (0-255)” is enabled.

Deprecated: Use Triggers[] / combotrigger::TintG instead!

---

int TrigTintB 🔗 Source

When triggered, the palette is tinted on the blue channel by this amount. -255 to 255.

-63 to 63 if compat QR “Scripts use 6-bit color (0-63) instead of 8-bit (0-255)” is enabled.

Deprecated: Use Triggers[] / combotrigger::TintB instead!

---

int TrigLvlPal 🔗 Source

The level palette to change to when triggered. -1 for none.

Deprecated: Use Triggers[] / combotrigger::LvlPal instead!

---

int TrigBossPal 🔗 Source

The boss palette to change to when triggered. -1 for none.

Deprecated: Use Triggers[] / combotrigger::BossPal instead!

---

int TrigQuakeTimer 🔗 Source

The quake timer to set when triggered. -1 for none.

Deprecated: Use Triggers[] / combotrigger::QuakeTimer instead!

---

int TrigWavyTimer 🔗 Source

The wavy timer to set when triggered. -1 for none.

Deprecated: Use Triggers[] / combotrigger::WavyTimer instead!

---

int TrigSwordJinx 🔗 Source

The duration to Sword Jinx the Hero for. -2 for none, -1 for ‘until cured’, 0 to cure.

Deprecated: Use Triggers[] / combotrigger::SwordJinx instead!

---

int TrigItemJinx 🔗 Source

The duration to Item Jinx the Hero for. -2 for none, -1 for ‘until cured’, 0 to cure.

Deprecated: Use Triggers[] / combotrigger::ItemJinx instead!

---

int TrigShieldJinx 🔗 Source

The duration to Shield Jinx the Hero for. -2 for none, -1 for ‘until cured’, 0 to cure.

Deprecated: Use Triggers[] / combotrigger::ShieldJinx instead!

---

int TrigStun 🔗 Source

The duration to Stun the Hero for. -2 for none, -1 for ‘until cured’, 0 to cure.

Deprecated: Use Triggers[] / combotrigger::Stun instead!

---

int TrigBunny 🔗 Source

The duration to Bunny the Hero for. -2 for none, -1 for ‘until cured’, 0 to cure.

Deprecated: Use Triggers[] / combotrigger::Bunny instead!

---

int TrigPushTime 🔗 Source

The duration that the combo must be pushed against for the ‘Push->’ trigger flag to take effect.

Deprecated: Use Triggers[] / combotrigger::PushTime instead!

---

Function descriptions

int PosX() 🔗 Source

Returns the X-coordinate of a combo from a combodata script, from the ‘this->’ pointer as ‘this->PosX()’.

Using this from any other combodata variable is illegal and undefined.

Deprecated: Use X instead!

---

int PosY() 🔗 Source

Returns the Y-coordinate of a combo from a combodata script, from the ‘this->’ pointer as ‘this->PosY()’.

Using this from any other combodata variable is illegal and undefined.

Deprecated: Use Y instead!

---

int Pos() 🔗 Source

Returns the combo screen index of a combo from a combodata script, from the ‘this->’ pointer as ‘this->Pos()’.

Using this from any other combodata variable is illegal and undefined.

Deprecated: Use Pos instead!

---

int Layer() 🔗 Source

Returns the layer the combo is on in a combodata script, from the ‘this->’ pointer as ‘this->Layer()’

Using this from any other combodata variable is illegal and undefined.

Deprecated: Use Layer instead!

---

combotrigger GetTrigger(char32[] buf) 🔗 Source

Gets the first trigger of this combo whose name exactly matches ‘buf’.