• Reference
• LUA API
• Classes
• Modifier

Modifier

Modifier is one of the basic elements in the project, which needs to be placed on the unit to produce the corresponding effect.

Functions

remove

Remove a modifier.

modifier: remove()

set_name

Set the name of the modifier.

Parameter

modifier:set_name(name)

set_description

Set the description of the modifier object.

Parameter

modifier:set_description(description)

set_remaining_time

Set remaining duration.

Parameter

modifier:set_remaining_time(time)

add_remaining_time

Increase remaining duration.

Parameter

modifier:add_remaining_time(time)

set_stacks

Set the number of stacked layers.

Parameter

modifier:set_stacks(stack)

add_stacks

Increase the number of stacked layers.

Parameter

modifier:add_stacks(stack)

set_shield_value

set shield value

Parameter

modifier:set_shield_value(value)

add_shield_value

Increase shield value.

Parameter

modifier:add_shield_value(value)

has_tag

Whether the modifier has a label or not.

Parameter

Return value

modifier:has_tag(tag)

icon_is_visible

Whether the icon of the modifier is visible or not.

Return value

modifier:icon_is_visible()

get_stacks

Get the stacked number of modifiers.

Return value

modifier: get_stacks()

get_remaining_duration

Get the remaining duration of the modifier.

Return value

modifier: get_remaining_duration()

get_modifier_type

Get the modifier type.

Return value

modifier: get_modifier_type()

get_modifier_effect_type

Get the modifier effect type.

Return value

modifier: get_modifier_effect_type()

get_max_stacks

Get the maximum number of stacks for modifiers.

Return value

modifier: get_max_stacks()

get_modifier_shield

Get a shield with magical effects.

Return value

modifier: get_modifier_shield()

get_affiliated_aura

Get the halo.

Return value

modifier: get_affiliated_aura()

get_cycle_time

Get modifier cycle.

Return value

modifier: get_cycle_time()

get_expended_modifier_duration

The duration of the modifier

Return value

modifier: get_expended_modifier_duration()

get_modifier_aura_effect_type

Get the aura effect type for the modifier.

Return value

modifier: get_modifier_aura_effect_type()

get_modifier_aura_range

Get the aura range of the modifier.

Return value

modifier: get_modifier_aura_range()

get_provider

Get the caster of the modifier.

Return value

modifier: get_provider()

get_receiver

Get the bearer of the modifier.

Return value

modifier: get_receiver()

get_name

Get the name of the modifier object.

Return value

modifier: get_name()

get_description

Get the description of the modifier object.

Return value

modifier: get_description()

get_level

Get grade.

Return value

modifier: get_level()

modifier_type_icon_is_visible

Whether the icon of the modifier type is visible or not.

Parameter

Return value

modifier.modifier_type_icon_is_visible(modifier_type)

get_type_of_modifier_entity

The category that gets the modifier.

Parameter

Return value

modifier. get_type_of_modifier_entity(modifier)

get_modifier_type_description

Get the description of the modifier type.

Parameter

Return value

modifier. get_modifier_type_description(modifier_type)

get_image_of_modifier_type_icon

Get the picture of the icon of the modifier type.

Parameter

Return value

modifier.get_image_of_modifier_type_icon(modifier_type)

Events

Magic effect triggers need to be contained in a group to use group variables.

Gain modifier

Get magic effect.

local modifier_group = cli.modifier.create_modifier_trigger_group ( 100001 )
modifier_group . add_trigger ( "Gain modifier" , function ( data )
    print ( "Get magic effect" )
end )

Lose modifier

Lost magic effect.

local modifier_group = cli.modifier.create_modifier_trigger_group ( 100001 )
modifier_group . add_trigger ( "Lose modifier)" , function ( data )
    print ( "Lost magic effect" )
end )

Period ends

Cycle expires.

local modifier_group = cli.modifier.create_modifier_trigger_group ( 100001 )
modifier_group . add_trigger ( "Period ends" , function ( data )
    print ( "Cycle Expired" )
end )

Modifier stacks change

Magic effect layer change event.

local modifier_group = cli.modifier.create_modifier_trigger_group ( 100001 )
modifier_group . add_trigger ( "Modifier stacks change)" , function ( data )
    print ( "Magic effect layer change event" )
end )

About to gain modifier

The magic effect is about to be obtained.

local modifier_group = cli.modifier.create_modifier_trigger_group ( 100001 )
modifier_group . add_trigger ( "About to gain modifier" , function ( data )
    print ( "The magic effect is about to be obtained" )
end )

Modifier overwritten

Magic effect override.

local modifier_group = cli.modifier.create_modifier_trigger_group ( 100001 )
modifier_group . add_trigger ( "Modifier overwritten" , function ( data )
    print ( "Magic effect overwrites" )
end )