Trigger API Reference DCEI Variables - funovus/editor-wiki GitHub Wiki
Table of Contents
- [Trigger API Reference\DCEI Variables](#trigger-api-referencedcei-variables)
* [Service](#service)
* [Unit](#unit)
* [Effect](#effect)
* [Ability](#ability)
* [Weapon](#weapon)
* [Behavior](#behavior)
* [Region](#region)
* [Input](#input)
* [Player](#player)
|
Trigger API Reference\DCEI Variables {trigger-api-referencedcei-variables}
string Platform
Returns the platform that the game is played on as one of the following string values:
local platform = DCEI.Platform
unit UnitAny
Returns an any unit, useful for binding generic trigger events.
function OnRegionEnter()
DCEI.LogMessage("Triggering Unit: " .. DCEI.UnitName(DCEI.TriggeringUnit))
end
DCEI.TriggerAddUnitEnterRegionEvent(DCEI.UnitAny, DCEI.RegionAny, OnRegionEnter)
unit TriggeringUnit
function OnRegionEnter()
local unit_name = DCEI.UnitName(DCEI.TriggeringUnit)
DCEI.LogMessage("Triggering Unit: " .. unit_name)
end
DCEI.TriggerAddUnitEnterRegionEvent(DCEI.UnitAny, DCEI.RegionAny, OnRegionEnter)
EffectContext TriggeringEffectContext
Returns the triggering effect's effect context.
function OnDoNothing()
local context = DCEI.TriggeringEffectContext
local caster_name = DCEI.UnitName(context.caster)
local source_name = DCEI.UnitName(context.source)
local target_name = DCEI.UnitName(context.target)
DCEI.LogMessage(caster_name .. " did nothing to " .. target_name .. " via " .. source_name .. ".")
end
DCEI.TriggerAddEffectEvent("DoNothing", OnDoNothing, true)
int TriggeringEffectId
Returns the triggering effect's id.
function OnDoNothing()
local id = DCEI.TriggeringEffectId
end
DCEI.TriggerAddEffectEvent("DoNothing", OnDoNothing, true)
string TriggeringEffectName
Returns the triggering effect's name.
function OnDoNothing()
local name = DCEI.TriggeringEffectName
end
DCEI.TriggerAddEffectEvent("DoNothing", OnDoNothing, true)
bool TriggeringEffectIsCritical
Returns if the damage is a critical damage. Only works in TriggerAddUnitDamageEvent
function OnTakingDamage()
local is_critical = DCEI.TriggeringEffectIsCritical
end
DCEI.TriggerAddUnitDamageEvent(DCEI.UnitAny, OnTakingDamage)
int TriggeringAbilityId
Returns the triggering ability's id.
function OnCastAbility()
local ability_id = DCEI.TriggeringAbilityId
end
DCEI.TriggerAddCastAbilityEvent(DCEI.UnitAny, OnAbilityCast)
string TriggeringAbilityName
Returns the triggering ability's name.
function OnCastAbility()
local ability_id = DCEI.TriggeringAbilityName
end
DCEI.TriggerAddCastAbilityEvent(DCEI.UnitAny, OnAbilityCast)
int TriggeringWeaponId
Returns the triggering weapon's id.
local function OnUnitUseWeapon()
local weapon = DCEI.TriggeringWeaponId
end
DCEI.TriggerAddUnitSelectedEvent(DCEI.UnitAny, OnUnitUseWeapon)
string TriggeringWeaponName
Return the triggering weapon's name.
local function OnUnitUseWeapon()
local weapon = DCEI.TriggeringWeaponId
end
DCEI.TriggerAddUnitSelectedEvent(DCEI.UnitAny, OnUnitUseWeapon)
int TriggeringBehaviorId
Return the triggering behavior's id.
function OnUnitBehaviorAdd()
local id = DCEI.TriggeringBehaviorId
end
DCEI.TriggerAddBehaviorAddEvent(DCEI.UnitAny, OnUnitBehaviorAdd, true)
string TriggeringBehaviorName
Returns the triggering behavior's name.
function OnUnitBehaviorAdd()
local name = DCEI.TriggeringBehaviorName
end
DCEI.TriggerAddBehaviorAddEvent(DCEI.UnitAny, OnUnitBehaviorAdd, true)
Region TriggeringRegion
Returns the triggering region.
function OnRegionEnter()
local r = DCEI.TriggeringRegion
end
DCEI.TriggerAddUnitEnterRegionEvent(DCEI.UnitAny, DCEI.RegionAny, OnRegionEnter)
Region RegionAny
Returns an any region, useful for binding generic trigger events.
function OnRegionEnter()
local region_name = DCEI.RegionName(DCEI.TriggeringRegion)
DCEI.LogMessage("A Unit Entered " .. region_name)
end
DCEI.TriggerAddUnitEnterRegionEvent(DCEI.UnitAny, DCEI.RegionAny, OnRegionEnter)
Float2 TriggeringJoystickAxes
Returns the triggering joystick axes.
function OnJoystickMove()
local axes = DCEI.TriggeringJoystickAxes
local pos = DCEI.GetUnitPosition2D(HERO)
-- order unit to move in direction of joystick axes
DCEI.Move(HERO, pos.x + axes.x, pos.y + axes.y)
DCEI.LogMessage("Joystick input: " .. axes.x .. ", " .. axes.y)
end
local joystick_options = {
offset = {
x = 148,
y = 148
},
anchor = {
x = 0,
y = 0
}
}
DCEI.TriggerAddJoystickEvent(OnJoystickMove, joystick_options)
int TriggeringJoystickId
Returns the triggering joystick's id.
function OnJoystickMove()
local id = DCEI.TriggeringJoystickId
end
local joystick_options = {
offset = {
x = 148,
y = 148
},
anchor = {
x = 0,
y = 0
}
}
DCEI.TriggerAddJoystickEvent(OnJoystickMove, joystick_options)
int TriggeringJoystickButtonId
Return the triggering joystick button's id.
function OnJoystickButton()
local button_id = DCEI.TriggeringJoystickButtonId
local button_event = DCEI.TriggeringJoystickButtonEventType
-- button event 0 is for ButtonDown, event 1 is for ButtonUp
if button_id == 0 and button_event == 0 then
-- currently does not support targeted abilities
-- movement commands will interrupt ability prep time / finish time, unless ability has "can cast while moving" flag checked
DCEI.CastAbility(HERO_SLASH, HERO, HERO)
end
end
DCEI.TriggerAddJoystickButtonEvent(0, OnJoystickButton, {icon = "icon_ingame_towerslot_barracks"})
int TriggeringJoystickButtonEventType
Returns the trigger joystick button event type. Button event 0 is for ButtonDown, event 1 is for ButtonUp.
function OnJoystickButton()
local button_id = DCEI.TriggeringJoystickButtonId
local button_event = DCEI.TriggeringJoystickButtonEventType
-- button event 0 is for ButtonDown, event 1 is for ButtonUp
if button_id == 0 and button_event == 0 then
-- currently does not support targeted abilities
-- movement commands will interrupt ability prep time / finish time, unless ability has "can cast while moving" flag checked
DCEI.CastAbility(HERO_SLASH, HERO, HERO)
end
end
DCEI.TriggerAddJoystickButtonEvent(0, OnJoystickButton, {icon = "icon_ingame_towerslot_barracks"})
int TriggeringPlayerId
Returns the triggering player's id.
function OnFocusChange()
DCEI.LogMessage("Focus changed: " .. DCEI.TriggeringPlayerId)
end
DCEI.TriggerOnFocusChange(OnFocusChange)