Fork me on GitHub

Available Packages:

EventHelper

function static unit.clearRegister()

function static trigger.getSource() returns unit

function static trigger.getSourceRect() returns rect

function static eventid.isKeyboardEvent() returns boolean

function static eventid.isMouseEvent() returns boolean

function static eventid.isPlayerunitEvent() returns boolean

function static region.loadRegionData() returns int

function static trigger.registerRectEnterEventSource(rect r)

function static trigger.registerRectLeaveEventSource(rect r)

function static trigger.registerUnitInRangeSource(unit whichUnit, real range, boolexpr filter) returns event

function static trigger.registerUnitInRangeSource(unit whichUnit, real range) returns event

function static region.removeRegionData()

function static region.setRegionData(int data)

function static trigger.unregisterRectEvent()

class EventData

This class exposes all Getters and Setters for trigger events. Note: As these functions simply wrap natives, they will only return proper values during event callbacks (actions/conditions). To use these values in a subsequent closure, save the event data in a variable at the time the event was fired.

function getAbilityTargetPos() returns vec2

function getAbsorbingItem() returns item

function getAttackerUnit() returns unit

function getBuyingUnit() returns unit

function getCancelledStructure() returns unit

Returns the building which was being constructed but as cancelled.

function getChangingUnit() returns unit

function getChangingUnitPreviousOwnerPlayer() returns player

function getChatMessage() returns string

function getChatMessageMatched() returns string

function getClickedDialog() returns dialog

function getClickedDialogButton() returns button

function getConstructedStructure() returns unit

Returns the building which is being constructed.

function getConstructingStructure() returns unit

Returns the unit which constructs the structure.

function getDamageAttackType() returns attacktype

function getDamageTarget() returns unit

function getDamageType() returns damagetype

function getDamageWeaponType() returns weapontype

function getDecayingUnit() returns unit

function getDetectedUnit() returns unit

function getDetectingPlayer() returns player

function getDyingUnit() returns unit

function getEnteringUnit() returns unit

function getEventDamage() returns real

Return damage done by Unit to another target unit.

function getEventDamageSource() returns unit

function getEventId() returns eventid

Get trigger event.

function getEventTargetUnit() returns unit

function getExpiredTimer() returns timer

function getGameState() returns gamestate

function getIsKeyDown() returns boolean

function getIssuedOrderId() returns int

function getKillingUnit() returns unit

function getLearnedSkill() returns int

function getLearnedSkillLevel() returns int

function getLearningUnit() returns unit

function getLeavingUnit() returns unit

function getLevelingUnit() returns unit

function getLoadedUnit() returns unit

Get unit thas is loaded to transport.

function getManipulatedItem() returns item

function getManipulatingUnit() returns unit

EVENT_PLAYER_UNIT_DROP_ITEM EVENT_PLAYER_UNIT_PICKUP_ITEM EVENT_PLAYER_UNIT_USE_ITEM EVENT_UNIT_DROP_ITEM EVENT_UNIT_PICKUP_ITEM EVENT_UNIT_USE_ITEM

function getMouseWorldPos() returns vec2

Returns player's mouse position on screen. Do not confuse with getMouseLocationVec2.

function getOrderPos() returns vec2

function getOrderTargetDestructable() returns destructable

function getOrderTargetItem() returns item

function getOrderTargetPos() returns vec2

function getOrderTargetUnit() returns unit

function getOrderX() returns real

function getOrderY() returns real

function getOrderedUnit() returns unit

function getPlayerMouseX() returns real

Return player's mouse X position on the terrain. Alternative: getMouseScreenVec2.

function getPlayerMouseY() returns real

Return player's mouse Y position on the terrain. Alternative: getMouseScreenVec2.

function getPlayerState() returns playerstate

function getRescuerUnit() returns unit

function getResearchedType() returns int

function getResearchingUnit() returns unit

function getRevivableUnit() returns unit

function getRevivingUnit() returns unit

function getSaveFilename() returns string

function getSellingUnit() returns unit

function getSoldItem() returns item

function getSoldUnit() returns unit

function getSpellAbility() returns ability

function getSpellAbilityId() returns int

function getSpellAbilityUnit() returns unit

function getSpellTargetDestructable() returns destructable

function getSpellTargetItem() returns item

function getSpellTargetPos() returns vec2

function getSpellTargetUnit() returns unit

function getSpellTargetX() returns real

function getSpellTargetY() returns real

function getStackingItemSource() returns item

EVENT_PLAYER_UNIT_STACK_ITEM Source is the item that is losing charges, Target is the item getting charges.

function getStackingItemTarget() returns item

EVENT_PLAYER_UNIT_STACK_ITEM Source is the item that is losing charges, Target is the item getting charges.

function getStackingItemTargetPreviousCharges() returns int

function getSummonedUnit() returns unit

function getSummoningUnit() returns unit

function getSyncData() returns string

function getSyncPrefix() returns string

function getTournamentFinishPlayer() returns player

function getTrainedUnit() returns unit

function getTrainedUnitType() returns int

function getTransportUnit() returns unit

Get unit that is transporting.

function getTriggerDestructable() returns destructable

function getTriggerFrame() returns framehandle

function getTriggerFrameEvent() returns frameeventtype

function getTriggerKey() returns oskeytype

function getTriggerMetaKey() returns OSKEY_META

function getTriggerPlayer() returns player

function getTriggerRegion() returns region

function getTriggerUnit() returns unit

function getWinningPlayer() returns player

function isAttackDamage() returns boolean

Returns `true` if the damage done is done with Unit's attack.

function isKeyboardEvent() returns boolean

Check if current trigger event is Keyboard Event.

function isManipulatedItemAbsorbed() returns boolean

function isMouseEvent() returns boolean

Check if current trigger event is Mouse Event.

function isPlayerunitEvent() returns boolean

Check if current trigger event is Playerunit Event.

function setDamage(real damage)

Change damage from damage event.

function setDamageAttackType(attacktype attackType)

Change damage from damage event.

function setDamageType(damagetype damageType)

Change damage from damage event.

function setDamageWeaponType(weapontype weaponType)

Change damage from damage event.