combodata#

Load with Game->LoadComboData(), mapdata::ComboData[], Screen->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 deprecated
int[]	Attrishorts deprecated
bool[]	Flags
bool[]	GenFlags
bool[]	LargeComboDirs
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 deprecated
int	LiftLightShape deprecated
int	LiftWeaponItem
int	SkipAnim
int	UserFlags
int	NextTimer
const combotrigger[]	Triggers
int	NumTriggers
bool	OnlyGenTriggers
int	ZHeight
int	ZStepHeight
int	DiveUnderLevel
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
const weapondata	LiftWeaponData
const weapondata	MiscWeaponData

Functions#

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

‘Refresh Animation on Room Entry’

AnimationBitflags AF_CYCLE = 2

‘Refresh Animation when cycled to’

AnimationBitflags AF_CYCLENOCSET = 4

‘Cycle Ignores CSet’

AnimationBitflags AF_TRANSPARENT = 8

‘Toggle Transparency’

AnimationBitflags AF_CYCLEUNDERCOMBO = 16

Added in version 3.0.

‘Cycle To Screen Undercombo’

AnimationBitflags AF_EDITOR_ONLY = 32

Added in version 3.0.

‘Only Visible In Editor’

AnimationBitflags AF_OVERHEAD = 64

Added in version 3.0.

‘Overhead’

enum ComboGeneralFlag: 🔗 Source

ComboGeneralFlag GENFLAG_HOOKSHOTTABLE = 0

ComboGeneralFlag GENFLAG_SWITCHHOOKABLE = 1

ComboGeneralFlag GENFLAG_WALK_ON_TOP = 2

Added in version 3.0.

ComboGeneralFlag GENFLAG_WALK_ON_TOP_DRAW_OFFSET = 3

Added in version 3.0.

ComboGeneralFlag GENFLAG_MAX = 4

Variable descriptions#

const int ID 🔗 Source

The combo’s ID.

const int X 🔗 Source

deprecated_getter PosX

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

deprecated_getter PosY

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

deprecated_getter Pos

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

deprecated_getter Layer

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

Changed in version 3.0: Used to be size 4

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

int[] Attribytes 🔗 Source

Deprecated: Use Attributes[] indexes 8-15 instead!

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

int[] Attrishorts 🔗 Source

Deprecated: Use Attributes[] indexes 16-23 instead!

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.

bool[] LargeComboDirs 🔗 Source

index Direction (DIR_)

length 4

Added in version 3.0.

Certain features, such as LF_LARGE_LIFTABLE, use this directions to connect to other combos forming a ‘Large Combo’. If a direction is set on this combo, and the combo on the same layer in that direction has the opposite direction set, the combos will be connected for features that use large combos.

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

Added in version 3.0.

Deprecated: use LiftWeaponData / weapondata::BurnLightRadius[] instead!

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

int LiftLightShape 🔗 Source

Added in version 3.0.

Deprecated: use LiftWeaponData / weapondata::LightShape instead!

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

Added in version 3.0.

The combo’s triggers.

int NumTriggers 🔗 Source

Added in version 3.0.

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

bool OnlyGenTriggers 🔗 Source

Added in version 3.0.

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

int ZHeight 🔗 Source

Added in version 3.0.

The Z-height of the combo for GENFLAG_WALK_ON_TOP. A value of ‘0’ represents infinite height.

int ZStepHeight 🔗 Source

Added in version 3.0.

The amount below the ZHeight that can still reach it to walk atop it via GENFLAG_WALK_ON_TOP. Designed for ‘walking up stairs’ type effects. Can’t be negative.

int DiveUnderLevel 🔗 Source

Added in version 3.0.

If >0 and the player is diving with flippers of at least this level, the player will ignore the solidity of this combo.

bool[] TrigFlags 🔗 Source

index ComboTriggerFlag (TRIGFLAG_)

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

The trigger flags of the combo.

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

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

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

int TrigChange 🔗 Source

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

The amount the combo will change by when triggered.

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

If 0, no change occurs.

int TrigCSetChange 🔗 Source

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

The amount the cset will change by when triggered.

int TrigProximity 🔗 Source

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

int TrigLightBeam 🔗 Source

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

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

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

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

int TrigCounter 🔗 Source

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

int TrigCtrAmount 🔗 Source

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

int TrigCooldown 🔗 Source

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

The combo’s cooldown between triggers

int TrigCopycat 🔗 Source

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

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

int TrigSpawnItemPickup 🔗 Source

value ItemPickupBitflags (IP_)

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

The item pickup bitflags for the spawned item.

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

int TrigExState 🔗 Source

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

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

int TrigExDoorDir 🔗 Source

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

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

int TrigExDoorIndex 🔗 Source

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

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

int TrigSpawnEnemy 🔗 Source

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

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

int TrigSpawnItem 🔗 Source

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

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

int TrigLevelState 🔗 Source

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

The LevelState used for the TRIGFLAG_TRIGLEVELSTATE and TRIGFLAG_LEVELSTATE

flags. 0-31, inclusive.

int TrigGlobalState 🔗 Source

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

The GlobalState used for the TRIGFLAG_TRIGGLOBALSTATE and TRIGFLAG_GLOBALSTATE

flags. 0-255, inclusive.

int TrigGStateTimer 🔗 Source

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

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

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

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

int TrigGroup 🔗 Source

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

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

0-255, inclusive.

int TrigGroupVal 🔗 Source

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

The value used for the TRIGFLAG_TGROUP_LESS and TRIGFLAG_TGROUP_GREATER flags.

0-65535, inclusive.

int TrigLItems 🔗 Source

Added in version 3.0.

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

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

int TrigDMapLvl 🔗 Source

Added in version 3.0.

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

The ‘Level’ used by ‘TrigLItems’.

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

int TrigTintR 🔗 Source

Added in version 3.0.

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

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

Added in version 3.0.

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

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

Added in version 3.0.

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

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

Added in version 3.0.

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

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

int TrigBossPal 🔗 Source

Added in version 3.0.

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

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

int TrigQuakeTimer 🔗 Source

Added in version 3.0.

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

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

int TrigWavyTimer 🔗 Source

Added in version 3.0.

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

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

int TrigSwordJinx 🔗 Source

Added in version 3.0.

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

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

int TrigItemJinx 🔗 Source

Added in version 3.0.

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

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

int TrigShieldJinx 🔗 Source

Added in version 3.0.

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

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

int TrigStun 🔗 Source

Added in version 3.0.

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

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

int TrigBunny 🔗 Source

Added in version 3.0.

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

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

int TrigPushTime 🔗 Source

Added in version 3.0.

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

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

const weapondata LiftWeaponData 🔗 Source

Added in version 3.0.

The weapondata for this combo’s lift weapon.

const weapondata MiscWeaponData 🔗 Source

Added in version 3.0.

The weapondata for this combo’s misc weapon.

Function descriptions#

combotrigger GetTrigger(char32[] buf) 🔗 Source

Added in version 3.0.

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