René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Definition changes in types","articleBody":"Due to how the engine works in Dota, some type definitions need to include \"undefined\" or \"void\" as an exit option. This occurs when the result is not something that you want to change, but rather, tell the engine to change nothing. It occurs mainly on conditional changes, such as client/server checks, or conditional occurrences. I'll detail the following functions with an example.\r\n\r\n**CastFilterResultTarget**: should be changed from \"UnitFilterResult\" to \"UnitFilterResult | undefined\".\r\nExample: Checking for a nearby allied unit in radius, which can only be done by the server. In this case, we must do `if (!IsServer()) return;` to exit from the client. The filter works regardless of the client's definition.\r\nExample:\r\n```ts\r\nCastFilterResultTarget(target: CDOTA_BaseNPC): UnitFilterResult | undefined\r\n    {\r\n        if (!IsServer()) return;\r\n\r\n        // Always apply on enemies according to the unit filter\r\n        if (target.GetTeamNumber() != this.caster.GetTeamNumber())\r\n        {\r\n            return UnitFilter(target, this.GetAbilityTargetTeam(), this.GetAbilityTargetType(), this.GetAbilityTargetFlags(), this.caster.GetTeamNumber());\r\n        }\r\n        else // Check on allies for disable help\r\n        {\r\n            if (PlayerResource.IsDisableHelpSetForPlayerID(target.GetPlayerOwnerID(), this.caster.GetPlayerOwnerID()))\r\n            {\r\n                return UnitFilterResult.FAIL_DISABLE_HELP;\r\n            }            \r\n\r\n            return UnitFilter(target, this.GetAbilityTargetTeam(), this.GetAbilityTargetType(), this.GetAbilityTargetFlags(), this.caster.GetTeamNumber());            \r\n        }\r\n    }\r\n```\r\n\r\n**ParticleManager.SetParticleControlEnt's attachment argument:** should be changed from \"string\" to \"string | undefined\". This is due to some particles requiring the usage of SetParticleControlEnt, but the attachment is ABSORIGIN_FOLLOW, which has no attachment.\r\nExample: Sven's God's Strength CP1 will only work with SetParticleControlEnt (for some weird reason...), but is set on the origin. It is used correctly in this form:\r\n```ts\r\nParticleManager.SetParticleControlEnt(this.particle_cast_fx, 1, this.caster, ParticleAttachment.ABSORIGIN_FOLLOW, undefined, this.caster.GetAbsOrigin(), true)\r\n```\r\n\r\n**CheckState()**: should be changed from \"Partial\u003cRecord\u003cModifierState, boolean\u003e\u003e\" to \"Partial\u003cRecord\u003cModifierState, boolean\u003e\u003e | undefined\". This is to allow cases where you no longer want to define any state. Returning true or false applies the effect on you (e.g. Invisibility, stunned) based on the priority of other modifier, which may ignore them. Instead, not returning anything (or returning undefined) lets the engine simply ignore this state.\r\nExample: \r\n```ts\r\nCheckState(): Partial\u003cRecord\u003cModifierState, boolean\u003e\u003e | undefined\r\n    {\r\n        if (this.proc_attack)\r\n        {\r\n            return {[ModifierState.CANNOT_MISS]: true}\r\n        }\r\n    }\r\n```\r\n\r\n**GetActivityTranslationModifiers()**: Should be changed from \"string\" to \"string | void\". This is due to the fact that sometimes you do not want any translation modifiers to be applied at all.\r\nExample: Night Stalker only applies the \"hunter_night\" translation at night, otherwise applies no translation:\r\n```ts\r\nGetActivityTranslationModifiers(): string | void\r\n    {\r\n        if (this.ShouldModifierBeActive())\r\n        {\r\n            return \"hunter_night\";\r\n        }\r\n        \r\n        return;\r\n    }\r\n```\r\n\r\n**GetModifierPreAttack_CriticalStrike()**: Should be changed from \"number\" to \"number | void\". Returning 0 still causes heroes that have critical strike animations (such as Phantom Assassin, Wraith King, Juggernaut) to proc those, which makes no sense if they're not actually proccing crits. Simply returning resolves this.\r\nExample:\r\n```ts\r\nGetModifierPreAttack_CriticalStrike(event: ModifierAttackEvent): number | void\r\n    {\r\n        // Does not apply on allies, buildings or wards\r\n        if (event.target.GetTeamNumber() == this.parent.GetTeamNumber() || event.target.IsBuilding() || event.target.IsOther()) return;\r\n\r\n     // some more irrelevant crit calculation logic....\r\n    }\r\n```\r\n","author":{"url":"https://github.com/JoyfulShush","@type":"Person","name":"JoyfulShush"},"datePublished":"2020-11-08T10:25:07.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/7/TypeScriptDeclarations/issues/7"}