Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc for Summon events and getters #133

Merged
merged 2 commits into from
Mar 24, 2024
Merged

Doc for Summon events and getters #133

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb418d9
Fix typo for EVENT_PLAYER_UNIT_SUMMON
Luashine Mar 22, 2024
c8161c6
Add doc for Summon events and getters
Luashine Mar 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions common.j
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3461,6 +3461,14 @@ will return `""`. Use `TriggerRegisterPlayerChatEvent` instead.
*/
constant playerunitevent EVENT_PLAYER_HERO_REVIVE_FINISH = ConvertPlayerUnitEvent(46)
/**
Runs when something summons a new unit under specified player's control.

Use `GetSummonedUnit` for the new unit and `GetSummoningUnit` for the spell caster.

@note See: `EVENT_UNIT_SUMMON`

@note `GetTriggerUnit` is equivalent to `GetSummonedUnit`.

@patch 1.00
*/
constant playerunitevent EVENT_PLAYER_UNIT_SUMMON = ConvertPlayerUnitEvent(47)
Expand Down Expand Up @@ -3642,6 +3650,17 @@ will return `""`. Use `TriggerRegisterPlayerChatEvent` instead.
constant unitevent EVENT_UNIT_HERO_REVIVE_FINISH = ConvertUnitEvent(83)

/**
Runs when a unit summons another unit.

Use `GetSummoningUnit` to get the spell caster.

@note `GetSummonedUnit` returns null, probably because the event happens before
the new unit is spawned.

@note `GetTriggerUnit` is equivalent to `GetSummoningUnit`.

@note See: `EVENT_PLAYER_UNIT_SUMMON`

@patch 1.00
*/
constant unitevent EVENT_UNIT_SUMMON = ConvertUnitEvent(84)
Expand Down Expand Up @@ -11570,18 +11589,23 @@ constant native GetDetectedUnit takes nothing returns unit
// EVENT_PLAYER_UNIT_SUMMONED

/**
Returns the unit who casted the summoning spell.

@event EVENT_PLAYER_UNIT_SUMMON
@event EVENT_UNIT_SUMMON

@event EVENT_PLAYER_UNIT_SUMMONED
@note See: `GetSummonedUnit`.

@patch 1.00
*/
constant native GetSummoningUnit takes nothing returns unit

/**
Returns the newly spawned unit.

@event EVENT_PLAYER_UNIT_SUMMON

@event EVENT_PLAYER_UNIT_SUMMONED
@note See: `GetSummoningUnit`.

@patch 1.00
*/
Expand Down