combodata

Variables

const int	X
const int	Y
const int	Pos
const int	Layer
untyped[]	InitD
const int	ID
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[]	TrigFlags
bool[]	Flags
bool[]	GenFlags
bool[]	TrigButton
int	TrigLevel
int	TrigItem
int	TrigTimer
int	TrigSFX
int	TrigChange
int	TrigProximity
int	TrigLightBeam
int	TrigCounter
int	TrigCtrAmount
int	TrigCooldown
int	TrigCopycat
int	TrigSpawnItemPickup
int	TrigExState
int	TrigExDoorDir
int	TrigExDoorIndex
int	TrigSpawnEnemy
int	TrigSpawnItem
int	TrigCSetChange
int	TrigLevelState
int	TrigGlobalState
int	TrigGStateTimer
int	TrigGenScript
int	TrigGroup
int	TrigGroupVal
int	TrigLItems
int	TrigDMapLvl
int	TrigTintR
int	TrigTintG
int	TrigTintB
int	TrigLvlPal
int	TrigBossPal
int	TrigQuakeTimer
int	TrigWavyTimer
int	TrigSwordJinx
int	TrigItemJinx
int	TrigShieldJinx
int	TrigStun
int	TrigBunny
int	TrigPushTime
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	LiftWeaponItem
int	SkipAnim
int	UserFlags
int[]	Expansion
int	NextTimer
int[]	TriggerFlags

Functions

int	PosX() deprecated
int	PosY() deprecated
int	Pos() deprecated
int	Layer() deprecated

Variable descriptions

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.

---

const int ID 🔗 Source

The combo ID this combodata points to.

---

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

How to flip (or rotate) the combo.

Valid values: TransformationType (FLIP_ or ROT_).

---

int Walk 🔗 Source

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

Valid values: ComboType (CT_).

---

int CSet 🔗 Source

Warning

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.

---

int NextCSet 🔗 Source

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

---

int Flag 🔗 Source

The inherent flag of the combo. Use the CF_ constants from std_constants.zh.

---

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

Bitwise access to the combo’s animation flags. Use the AF_ constants to access.

---

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[] TrigFlags 🔗 Source

The trigger flags of the combo

Use the TRIGFLAG_ constants from std_constants.zh

---

bool[] Flags 🔗 Source

The 16 combo flags. Their effect depends on the combo type.

---

bool[] GenFlags 🔗 Source

The combo generic flags, specified by the GENFLAG_ constants.

---

bool[] TrigButton 🔗 Source

---

int TrigLevel 🔗 Source

---

int TrigItem 🔗 Source

---

int TrigTimer 🔗 Source

---

int TrigSFX 🔗 Source

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

---

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.

---

int TrigProximity 🔗 Source

---

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:ref:`TRIGFLAG_LIGHTON<libs_std_enum_member_trigflag_lighton>` (trigger when hit by matching light) - TriggerFlags:ref:`TRIGFLAG_LIGHTOFF<libs_std_enum_member_trigflag_lightoff>` (trigger when NOT hit by matching light)

---

int TrigCounter 🔗 Source

---

int TrigCtrAmount 🔗 Source

---

int TrigCooldown 🔗 Source

The combo’s cooldown between triggers

---

int TrigCopycat 🔗 Source

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

---

int TrigSpawnItemPickup 🔗 Source

The item pickup flags for the spawned item

Only the flags IP_HOLDUP, IP_TIMEOUT, IP_TRIGGERSECRETS, IP_ALWAYSGRAB are used.

---

int TrigExState 🔗 Source

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

---

int TrigExDoorDir 🔗 Source

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

---

int TrigExDoorIndex 🔗 Source

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

---

int TrigSpawnEnemy 🔗 Source

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

---

int TrigSpawnItem 🔗 Source

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

---

int TrigCSetChange 🔗 Source

The amount the cset will change by when triggered.

---

int TrigLevelState 🔗 Source

The LevelState used for the TRIGFLAG_TRIGLEVELSTATE and TRIGFLAG_LEVELSTATE

flags. 0-31, inclusive.

---

int TrigGlobalState 🔗 Source

The GlobalState used for the TRIGFLAG_TRIGGLOBALSTATE and TRIGFLAG_GLOBALSTATE

flags. 0-255, inclusive.

---

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.

---

int TrigGenScript 🔗 Source

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

---

int TrigGroup 🔗 Source

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

0-255, inclusive.

---

int TrigGroupVal 🔗 Source

The value used for the TRIGFLAG_TGROUP_LESS and TRIGFLAG_TGROUP_GREATER flags.

0-65535, inclusive.

---

int TrigLItems 🔗 Source

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

---

int TrigDMapLvl 🔗 Source

The ‘Level’ used by ‘TrigLItems’.

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

---

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.

---

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.

---

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.

---

int TrigLvlPal 🔗 Source

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

---

int TrigBossPal 🔗 Source

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

---

int TrigQuakeTimer 🔗 Source

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

---

int TrigWavyTimer 🔗 Source

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

---

int TrigSwordJinx 🔗 Source

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

---

int TrigItemJinx 🔗 Source

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

---

int TrigShieldJinx 🔗 Source

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

---

int TrigStun 🔗 Source

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

---

int TrigBunny 🔗 Source

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

---

int TrigPushTime 🔗 Source

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

---

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

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 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[] Expansion 🔗 Source

Reserved for future use by the Combo Editor.

---

int NextTimer 🔗 Source

---

int[] TriggerFlags 🔗 Source

---

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.

Warning

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.

Warning

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.

Warning

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.

Warning

Deprecated! Use Layer instead!