ModDota

https://moddota.com/
Admin
ModDota is a community-driven hub for Dota 2 custom game development, providing comprehensive...
Tokens:217,433
Snippets:1,447
Trust Score:7.1
Update:5 days ago
Show doc for...
Tokens:
Raw
### Install the Tooltip Generator package

Source: https://moddota.com/scripting/Typescript/tooltip-generator

Run this command in the addon's root folder to install @shushishtok/tooltip_generator. It triggers a final installation that may take a few minutes. Warnings can be ignored.

```bash
npm install @shushishtok/tooltip_generator
```

--------------------------------

### Example item_drops.kv file

Source: https://moddota.com/scripting/item-drop-system

Complete example configuration for the item drop system. Defines global settings (MaxTime, MaxDropsOnScreen), item quality colors, excluded qualities, and drop tables for titan and demon enemies with item sets and drop chances.

```kv
"Drops"
{
    //===============================================
    // ItemDrops UI Configuration
    //===============================================

    "MaxTime"        "60"
    "MaxDropsOnScreen"  "3"

    "ItemQualityColors"
    {
        "artifact"  "#FFA500" //Orange
        "epic"      "#8847FF" //Purple
        "rare"      "#4B69FF" //Blue
        "common"    "#00FF00" //Lime Green
        "component" "#FFFFFF" //White
        "consumable" "#FFFFFF" //White
    }

    // Don't fire the item_drop event for these
    "ExcludedQualities"
    {
        "consumable" "1"
        "component"  "1"
    }

    //===============================================
    // Roll Drops Configuration
    // Zone Specific
    //===============================================

    //===============================================
    // Titans
    //===============================================

    "titan_Avatar_of_Earth"
    {
        "1"
        {
            "ItemSets"
            {
                "1" "item_boots_of_agility_16"
                "2" "item_cloak_of_flames_25"
                "3" "item_gauntlets_of_might_16"
                "4" "item_orb_of_mana"
                "5" "item_life_gem"
                "6" "item_firehand_gauntlets_20"
                "7" "item_robes_of_enlightenment_16"
            }
            "Chance"   "100"
        }
    }
    "titan_Avatar_of_Nature"
    {
        "1"
        {
            "ItemSets"
            {
                "1" "item_boots_of_agility_16"
                "2" "item_heros_blade"
                "3" "item_gauntlets_of_might_16"
                "4" "item_orb_of_mana"
                "5" "item_ring_of_spell_power"
                "6" "item_heros_hauberk"
                "7" "item_robes_of_enlightenment_16"
                "8" "item_ring_of_healing_power"
            }
            "Chance"   "100"
        }
    }
    "titan_Avatar_of_Justice"
    {
        "1"
        {
            "ItemSets"
            {
                "1" "item_boots_of_agility_16"
                "2" "item_cloak_of_flames_25"
                "3" "item_gauntlets_of_might_16"
                "4" "item_orb_of_mana"
                "5" "item_life_gem"
                "6" "item_firehand_gauntlets_20"
                "7" "item_robes_of_enlightenment_16"
            }
            "Chance"   "100"
        }
    }
    "titan_Avatar_of_Death"
    {
        "1"
        {
            "ItemSets"
            {
                "1" "item_ring_of_regeneration"
                "2" "item_tbr_ring_of_health"
                "3" "item_pendant_of_energy"
            }
            "Chance"   "100"
        }
    }
    "titan_Avatar_of_the_Sky"
    {
        "1"
        {
            "ItemSets"
            {
                "1" "item_ring_of_regeneration"
                "2" "item_tbr_ring_of_health"
                "3" "item_pendant_of_energy"
            }
            "Chance"   "100"
        }
    }
    "titan_Avatar_of_Sacrifice"
    {
        "1"
        {
            "ItemSets"
            {
                "1" "item_ring_of_regeneration"
                "2" "item_tbr_ring_of_health"
                "3" "item_pendant_of_energy"
            }
            "Chance"   "100"
        }
    }
    "titan_Avatar_of_the_Sea"
    {
        "1"
        {
            "ItemSets"
            {
                "1" "item_ring_of_regeneration"
                "2" "item_tbr_ring_of_health"
                "3" "item_pendant_of_energy"
            }
            "Chance"   "100"
        }
    }
    "titan_Mother_of_Earth"
    {
        "1"
        {
            "ItemSets"
            {
                "1" "item_ring_of_regeneration"
                "2" "item_tbr_ring_of_health"
                "3" "item_pendant_of_energy"
            }
            "Chance"   "100"
        }
    }

    //===============================================
    // Demon Area
    //===============================================

	"demon_imp"     // noob tier
    {
        "1"
        {
            "Item"     "item_potion_of_minor_healing"
            "Chance"   "10"
        }
        "2"
        {
            "Item"     "item_gold_bag_100"
            "Chance"   "10"
        }
        "3"
        {
            "ItemSets"
            {
                "1" "item_talisman_of_health"
                "2" "item_ring_of_regeneration"
                "3" "item_apprentice_robes"
                "4" "item_hard_leather_armor"
                "5" "item_ring_mail"
            }
            "Chance"   "3"
        }
    }
}
```

--------------------------------

### OnSpellStart Example Ability

Source: https://moddota.com/abilities/datadriven/datadriven-ability-events-modifiers

An example ability that damages all units in a 500 radius of the clicked point when the spell finishes casting. Uses AbilityBehavior POINT and AOE, with cast range, cast point, cooldown, mana cost, damage, and AoE radius.

```kv
"ability_active"
{
    // General
    //-------------------------------------------------------------------------------------
    "BaseClass"             "ability_datadriven"
    "AbilityBehavior"       "DOTA_ABILITY_BEHAVIOR_POINT | DOTA_ABILITY_BEHAVIOR_AOE"
    "AbilityUnitTargetTeam" "DOTA_UNIT_TARGET_TEAM_ENEMY"
    "AbilityUnitTargetType" "DOTA_UNIT_TARGET_HERO | DOTA_UNIT_TARGET_BASIC"
    "AbilityUnitDamageType" "DAMAGE_TYPE_MAGICAL"

    // Stats
    //-------------------------------------------------------------------------------------
    "AbilityCastRange" "700"   // This will  also show a circle when hovering over the spell
    "AbilityCastPoint" "0.5"   // Cast animation time
    "AbilityCooldown"  "7"
    "AbilityManaCost"  "50 100 150 200"
    "AbilityDamage"    "100 200 300 400"
    "AOERadius" "500"  // This displays the AoE Helper, it doesn't have a real impact on the spell

    // Special
    //-------------------------------------------------------------------------------------
    "AbilitySpecial"
    {
        "01"
        {
            "var_type" "FIELD_INTEGER"
            "radius" "500"
        }
    }
}
```

--------------------------------

### AbilityValues block example

Source: https://moddota.com/abilities/passing-abilityvalues-values-into-lua

Example AbilityValues block with radius and mana_per_second values.

```kv
"AbilityValues"
{
  "radius" "300"
  "mana_per_second" "5 10 15 20"
}
```

--------------------------------

### Install TypeScript and panorama-types via npm

Source: https://moddota.com/panorama/introduction-to-panorama-ui-with-typescript

Execute this command in a command prompt to install TypeScript and the panorama-types definitions as dev dependencies.

```bash
npm install -D typescript panorama-types
```

--------------------------------

### Initial npc_abilities_custom.txt content

Source: https://moddota.com/tools/combining-kv-files-using-base

The starting KV file with two abilities before splitting.

```kv
"DOTAAbilities"
{
    "Ability1"
    {
        "SomeProperty1"    "1"
        "SomeProperty2"    "2"
    }

    "Ability2"
    {
        "SomeProperty1"    "1"
        "SomeProperty2"    "2"
    }
}
```

--------------------------------

### Console output for OnUpgrade (any behavior)

Source: https://moddota.com/abilities/datadriven/all-about-the-target

Example console output for OnUpgrade event. Only caster is available.

```text
CASTER: npc_dota_hero_alchemist
```

--------------------------------

### Basic item definition structure

Source: https://moddota.com/abilities/item-keyvalues

Start with 'item_' and your item name. Omitting the prefix causes issues.

```kv
"item_custom"
{ ... }
```

--------------------------------

### DataDriven ControlPointEntities Example 1

Source: https://moddota.com/scripting/particle-attachment

Sets control points in order; each key corresponds to a CP index. To set CP8, you need 8 lines. This example sets two control points to attach_origin.

```kv
"modifier_aphotic_shield"
{
    "OnDestroy"
    {
        "AttachEffect"
        {
             "EffectName" "particles/units/heroes/hero_abaddon/abaddon_aphotic_shield_explosion.vpcf"
             "EffectAttachType" "follow_origin"
             "Target" "UNIT"
             "ControlPointEntities"
            {
                "TARGET" "attach_origin"
                "TARGET" "attach_origin"
            }
        }
    }
}
```

--------------------------------

### OnProjectileHitUnit Damage Example

Source: https://moddota.com/abilities/datadriven/datadriven-ability-events-modifiers

Example of an OnProjectileHitUnit event that applies physical damage to the target and deletes the projectile on hit. Uses %AbilityDamage for damage scaling.

```kv
"OnProjectileHitUnit"
{
    "DeleteOnHit" "1"
    "Damage"
    {
        "Type" "DAMAGE_TYPE_PHYSICAL"
        "Damage" "%AbilityDamage"
        "Target" "TARGET"
    }
}
```

--------------------------------

### OnSpellStart and OnProjectileHitUnit with RunScript

Source: https://moddota.com/abilities/datadriven/all-about-the-target

Shows how to set up RunScript for both OnSpellStart and OnProjectileHitUnit events, passing the target point to the same function.

```kv
"OnSpellStart"
{
    "RunScript"
    {
        "ScriptFile"  "test.lua"
        "Function"    "TargetTest"
        "EventName"   "OnSpellStart"
        "Target"      "POINT"
    }
}

"OnProjectileHitUnit"
{
    "DeleteOnHit"  "1"
    "RunScript"
    {
        "ScriptFile"  "test.lua"
        "Function"    "TargetTest"
        "EventName"   "OnProjectileHitUnitUnit"
        "Target"      "POINT"
    }
}
```

--------------------------------

### Timers.CreateTimer example in GameMode.ts

Source: https://moddota.com/scripting/Typescript/typescript-events

Example of using Timers.CreateTimer to delay an action. In this case, it finishes custom game setup after 3 seconds if in tools mode.

```typescript
// Automatically skip setup in tools
if (IsInToolsMode()) {
  Timers.CreateTimer(3, () => {
    GameRules.FinishCustomGameSetup();
  });
}
```

--------------------------------

### Built-in event listener example (npc_spawned)

Source: https://moddota.com/scripting/Typescript/typescript-events

Example of registering a built-in event listener for 'npc_spawned'. The callback receives an NpcSpawnedEvent with properties entindex and is_respawn. Use EntIndexToHScript to get the entity handle.

```typescript
ListenToGameEvent('npc_spawned', (event: NpcSpawnedEvent) => {
  // ...
}, undefined);
```

--------------------------------

### Launch Dota2 Tools with test addon

Source: https://moddota.com/tools/improvement-vConsole

Example configuration for launching Dota2 Tools with a test addon and launch parameters. Specifies the executable path and arguments including -tools, -addon test, and -vconsole.

```text
{
    m_Name                      = "tp"
    m_MenuString                = "Test project"
    m_SubToolIconPath           = "game:tools/images/hammer/toggle_tools_materials_activated.png"
    m_ToolbarString             = "Test A"
    m_StatusBarTipString        = "Test Addon load"
    m_ExecutablePath            = "X:\\Steam\\steamapps\\common\\dota 2 beta\\game\\bin\\win64\\dota2.exe"
    m_ExecutableArguments       = "-nobreakpad 375360 -tools -addon test -novid -uidev -dev -nominidumps -condebug -toconsole -vconsole "
}
```

--------------------------------

### Rotate Caster Every Interval Example

Source: https://moddota.com/abilities/datadriven/rotate-ability-example

Example showing how to rotate the caster every interval. It applies a modifier 'modifier_rotating' on spell start, and the modifier's OnIntervalThink uses the Rotate block with PitchYawRoll values from parameters %x %y %z.

```kv
"OnSpellStart"
{
    "ApplyModifier"
    {
        "ModifierName"	"modifier_rotating"
        "Target"       "CASTER"
    }
}

"Modifiers"
{
    "modifier_rotating"
    {
        "ThinkInterval" "%interval"
        "OnIntervalThink"
        {
            "Rotate"
            {
                "Target"       "TARGET"
                "PitchYawRoll"	"%x %y %z"
            }
        }
    }
}
```

--------------------------------

### Lua example using GetSpecialValueFor and GetLevelSpecialValueFor

Source: https://moddota.com/abilities/passing-abilityvalues-values-into-lua

Lua code to retrieve ability values. GetSpecialValueFor gets the value for the current level, while GetLevelSpecialValueFor gets the value for a specified level. Note that ability levels are 1-indexed but GetLevelSpecialValueFor is 0-indexed, so subtract 1 from the ability level.

```lua
local ability = event.ability
local radius = ability:GetSpecialValueFor("radius")
local mana_per_second = ability:GetLevelSpecialValueFor("mana_per_second", (ability:GetLevel() - 1))
```

--------------------------------

### Initialize npc_items_custom.txt with empty DOTAAbilities block

Source: https://moddota.com/abilities/lua-item-tutorial

Creates the initial structure for the custom items file. This is the starting point before adding the item definition.

```txt
"DOTAAbilities"
{
}
```

--------------------------------

### Linken's Sphere Absorb Implementation

Source: https://moddota.com/abilities/lua-modifiers/2

Example GetAbsorbSpell that blocks a spell when the ability is off cooldown, then starts the cooldown. Returns 1 to block, false otherwise.

```lua
function my_modifier:GetAbsorbSpell(keys)
    local hAbility = self:GetAbility()
    if hAbility:IsCooldownReady() then
    --your cool effect here.
    hAbility:StartCooldown(hAbility:GetCooldown(hAbility:GetLevel()))
    return 1
    end
    return false
end
```

--------------------------------

### Initialize the Tooltip Generator

Source: https://moddota.com/scripting/Typescript/tooltip-generator

Run this command after installation to generate localization files in the resource folder. This will erase all existing addon localization files, so back them up first.

```bash
npm run init
```

--------------------------------

### Set addon name in package.json

Source: https://moddota.com/scripting/Typescript/typescript-introduction

Edit the 'name' field in package.json to the desired custom game name. The example uses 'typescript_tutorial'. Ensure no folder with that name exists in game/dota_addons or content/dota_addons before running npm install.

```json
"name": "typescript_tutorial",
```

--------------------------------

### Ability with LinearProjectile and OnProjectileHitUnit

Source: https://moddota.com/abilities/datadriven/datadriven-ability-events-modifiers

Complete ability example that fires a linear projectile on spell start. The projectile stuns in a radius when it finishes its fixed distance. OnProjectileHitUnit sets DeleteOnHit to 0 so the projectile continues after hitting a unit.

```kv
"ability_projectile_linear"
{
    // General
    //-------------------------------------------------------------------------------------
    "BaseClass" "ability_datadriven"
    "AbilityBehavior" "DOTA_ABILITY_BEHAVIOR_POINT"
    "AbilityUnitTargetTeam" "DOTA_UNIT_TARGET_TEAM_ENEMY"
    "AbilityUnitTargetType" "DOTA_UNIT_TARGET_HERO | DOTA_UNIT_TARGET_BASIC"
    "AbilityUnitDamageType" "DAMAGE_TYPE_PURE"

    // Stats
    //-------------------------------------------------------------------------------------
    "AbilityCastRange" "600"
    "AbilityDamage" "100"

    // Special
    //-------------------------------------------------------------------------------------
    "AbilitySpecial"
    {
        "01"
        {
            "var_type" "FIELD_INTEGER"
            "distance" "600"
        }
        "02"
        {
            "var_type" "FIELD_INTEGER"
            "damage_aoe" "300"
        }
    }

    "precache"
    {
        "particle" "particles/units/heroes/hero_mirana/mirana_spell_arrow.vpcf" //linear
    }

    // Data Driven
    //-------------------------------------------------------------------------------------
    "OnSpellStart"
    {
        "LinearProjectile"
        {
            "Target" "POINT"
            "EffectName" "particles/units/heroes/hero_mirana/mirana_spell_arrow.vpcf"
            "MoveSpeed" "600"
            "StartRadius" "125"
            "StartPosition" "attach_attack1"
            "EndRadius" "125"
            "FixedDistance" "500"
            "TargetTeams" "DOTA_UNIT_TARGET_TEAM_ENEMY"
            "TargetTypes" "DOTA_UNIT_TARGET_BASIC | DOTA_UNIT_TARGET_HERO"
            "TargetFlags" "DOTA_UNIT_TARGET_FLAG_NONE"
            "HasFrontalCone" "0"
            "ProvidesVision" "1"
            "VisionRadius" "300"
        }
    }

    "OnProjectileHitUnit"
    {
        "DeleteOnHit" "0" // This will make the projectile continues its trajectory after hitting
    }
}
```

--------------------------------

### Launch VSCode with workspace

Source: https://moddota.com/tools/improvement-vConsole

Example configuration for launching VSCode with a workspace file as an argument. Specifies the executable path and the workspace path.

```text
{
    m_Name                      = "vsc"
    m_MenuString                = "VSCode"
    m_SubToolIconPath           = "C:/Microsoft VS Code/resources/app/resources/win32/code_70x70.png"
    m_ToolbarString             = "VSCode XX"
    m_StatusBarTipString        = "Run Vscode Addon XxxXxx"
    m_ExecutablePath            = "X:\\Microsoft VS Code\\Code.exe"
    m_ExecutableArguments       = "X:\\xxxx\\xx_scripts.code-workspace"
}
```

--------------------------------

### DataDriven SpawnUnit action with OnSpawn

Source: https://moddota.com/units/unit-producing-buildings

Use this DataDriven action to spawn units from a building. It supports OnSpawn sub-events, unit count, limit, and modifier_kill integration. The example applies modifier_phased for 1 frame to prevent units getting stuck.

```kv
"SpawnUnit"
{
    "UnitName"       "npc_name"
    "Target"         "CASTER"
    "Duration"       "%duration"
    "UnitCount"      "1"
    "UnitLimit"      "0"
    "GrantsGold"     "1"
    "GrantsXP"       "1"
    "SpawnRadius"    "10"
    "OnSpawn"
    {
        "ApplyModifier"
        {
            "ModifierName"  "modifier_phased"
            "Target"        "TARGET"
            "Duration"      "0.03"
        }
        [ACTIONS]
    }
}
```

--------------------------------

### Lua: Hide HUD component with SetHUDVisible on game mode entity

Source: https://moddota.com/panorama/hiding-hud-with-sethudvisible

Usage example for SetHUDVisible, called on the game mode entity during a game started event (e.g., player_connect_full). The first argument is the HUD component value from the table (e.g., 0 for DOTA_HUD_VISIBILITY_TOP_TIMEOFDAY). Note that changing it once prevents changing it back without restarting tools.

```lua
mode = GameRules:GetGameModeEntity()
mode:SetHUDVisible(hud_component_value, false)
```

--------------------------------

### Configuration parameters for sdk_vconsole_subtools.txt

Source: https://moddota.com/tools/improvement-vConsole

Lists the key-value parameters used in the vConsole subtools configuration file, including m_Name, m_MenuString, m_SubToolIconPath, m_ToolbarString, m_StatusBarTipString, m_CommandString, m_ExecutablePath, m_ExecutableArguments, m_LibraryPath, m_AdditionalDependencies, m_bRequiresAppConnection, m_bRequiresToolConnection, m_bInternalUseOnly, m_bAllowAutoStart, m_ToolConfig, m_MaterialSystemDependencies, and m_SubTools. Comments are supported with //.

```text
m_Name                       - Section name - importance is low, no visibility (but better to use).
m_MenuString                 - Name for menu list Tools.
m_SubToolIconPath            - Path for image icon (Button or menu). Great choice here "\dota 2 beta\game\core\tools\images\". You can also shorten the way "game:tools/images/workshopmanager/icon_refresh_activated.png"
m_ToolbarString              - Name for button.
m_StatusBarTipString         - ToolTip in status bar and pop-up tooltip on the button.
m_CommandString              - any/all console commands that you already use in Dota2 Tools, (commands separated by semicolons are executed alternately, as in the console).
m_ExecutablePath             - the path to the executable file. (the slash in the path name, must be escaped with a slash \\)
m_ExecutableArguments        - arguments to run the executable file
m_LibraryPath                - the path to the DLL (for internal Dota tools)
m_AdditionalDependencies     - additional dependencies (probably expand the tools we are not really available)
m_bRequiresAppConnection     - Checking the connection to the application Dota2 (if Dota2 is running the icon takes full color, otherwise the icon is completely in shades of gray and cannot be clicked)
m_bRequiresToolConnection    - Checking the connection to the application Dota2 Tools (AssetBrowser only in tools, netgraph is also available in Dota2)
m_bInternalUseOnly           - only internal use - the essence is not clear.
m_bAllowAutoStart            - run at console start (not sure if it works in every situation)
m_ToolConfig                 - I don't know what it's for.(Maybe here you can specify the config from PET Hammer and other tools)
m_MaterialSystemDependencies - we are not interested (section with other dependencies - did not notice the difference by editing it)
m_SubTools                   - Our area for customization
// +dota_launch_custom_game  - comments work
```

--------------------------------

### Full DataDriven ability example: human_train_footman

Source: https://moddota.com/units/unit-producing-buildings

Complete ability definition using SpawnUnit. Includes ability behavior, gold cost, and OnSpellStart block. The [ACTIONS] placeholder is replaced with actual actions in practice.

```kv
"human_train_footman"
{
    "BaseClass"             "ability_datadriven"
    "AbilityTextureName"    "footman"
    "MaxLevel"              "1"

    "AbilityBehavior"    "DOTA_ABILITY_BEHAVIOR_NO_TARGET"

    "AbilityGoldCost"    "10"

    "OnSpellStart"
    {

    }
```

--------------------------------

### Install lodash with npm

Source: https://moddota.com/panorama/webpack

Command to install the lodash library as a dependency for the project.

```shell
npm install lodash
```

--------------------------------

### addoninfo.txt Default_Keys configuration

Source: https://moddota.com/panorama/keybindings

Add this block to your addoninfo.txt file located in /game/<your addon>/addoninfo.txt. It defines two keybindings: 'S' fires 'CustomGameExecuteAbility1' and 'Z' fires '+CustomGameTestButton'. Use capital letters for the Key value and ensure the Command name is unique.

```text
"AddonInfo"
{
  "TeamCount" "10"
  "maps"      "your_map"
  "IsPlayable"  "1"
  "your_map"
  {
          "MaxPlayers"                    "10"
  }
  "Default_Keys"
    {
        "01"
        {
            "Key"       "S"
            "Command"   "CustomGameExecuteAbility1"
            "Name"      "Execute Ability 1"
        }
        "02"
        {
            "Key"       "Z"
            "Command"   "+CustomGameTestButton"
            "Name"      "Example"
        }
    }
}
```

--------------------------------

### Shell: Install sass-loader and sass

Source: https://moddota.com/panorama/webpack

Installs sass-loader and sass as dev dependencies to enable SASS/SCSS processing.

```shell
npm install -D sass-loader sass
```

--------------------------------

### Console output for OnAbilityPhaseStart (unit target)

Source: https://moddota.com/abilities/datadriven/all-about-the-target

Example console output for OnAbilityPhaseStart when casting with unit target behavior. Shows caster, target, unit, and attacker.

```text
CASTER: npc_dota_hero_alchemist
TARGET: npc_dota_hero_abaddon
UNIT: npc_dota_hero_alchemist
ATTACKER: npc_dota_hero_alchemist
```

--------------------------------

### Shell: Install file-loader for CSS

Source: https://moddota.com/panorama/webpack

Installs the file-loader package as a dev dependency to handle CSS files in webpack.

```shell
npm install -D file-loader
```

--------------------------------

### Console output for OnAbilityPhaseStart (no target)

Source: https://moddota.com/abilities/datadriven/all-about-the-target

Example console output for OnAbilityPhaseStart with DOTA_ABILITY_BEHAVIOR_NO_TARGET. Shows caster, unit, and attacker.

```text
CASTER: npc_dota_hero_alchemist
UNIT: npc_dota_hero_alchemist
ATTACKER: npc_dota_hero_alchemist
```

--------------------------------

### Install TypeScript and fork-ts-checker-webpack-plugin dependencies

Source: https://moddota.com/panorama/webpack

Install typescript, ts-loader, fork-ts-checker-webpack-plugin, and panorama-types to enable TypeScript support for Panorama.

```shell
npm install -D typescript ts-loader fork-ts-checker-webpack-plugin
npm install panorama-types
```

--------------------------------

### ExampleUI class creating PlayerPortrait instances

Source: https://moddota.com/panorama/introduction-to-panorama-ui-with-typescript

Creates an ExampleUI class that finds a container element and instantiates three PlayerPortrait objects for different heroes, setting different health percentages.

```typescript
class ExampleUI {
  // Instance variables
  panel: Panel;

  // ExampleUI constructor
  constructor(panel: Panel) {
    this.panel = panel;

    // Find container element
    const container = this.panel.FindChild('HeroPortraits')!;

    // Create portrait for player 0, 1 and 2
    const portrait0 = new PlayerPortrait(container, 'npc_dota_hero_juggernaut', 'Player0');
    const portrait1 = new PlayerPortrait(container, 'npc_dota_hero_omniknight', 'Player1');
    const portrait2 = new PlayerPortrait(container, 'npc_dota_hero_invoker', 'Player2');

    // Set HP of player 1 and 2 to a different value
    portrait0.SetHealthPercent(80);
    portrait2.SetHealthPercent(20);
  }
}

let ui = new ExampleUI($.GetContextPanel());
```

--------------------------------

### Modifier property name examples

Source: https://moddota.com/abilities/modifier-properties-in-tooltips

Examples of using modifier property names in the format. Ensure there is no empty space.

```plaintext
%dMODIFIER_PROPERTY_ATTACKSPEED_BONUS_CONSTANT%
```

```plaintext
%fMODIFIER_PROPERTY_TOOLTIP%
```

--------------------------------

### OnAttackStart: Random Crit or Stun on Attack Start

Source: https://moddota.com/abilities/datadriven/datadriven-ability-events-modifiers

Applies a random modifier when an attack starts. Removes the 'modifier_good_luck' on each attack start to prevent canceling attacks for a guaranteed crit. 50% chance to apply the crit modifier, otherwise stuns the caster for 0.5 seconds.

```keyvalues
"modifier_luck"
{
    "IsHidden" "1"
    "IsBuff" "1"
    "Passive" "1"

    "OnAttackStart"
    {
        // Remove the modifier on each attack start to disable people
        // from canceling attacks to get a guaranteed crit.
        "RemoveModifier"
        {
            "ModifierName" "modifier_good_luck"
            "Target" "CASTER"
        }
        "Random"
        {
            "Chance" "50"
            "OnSuccess"
            {
                "ApplyModifier"
                {
                    "ModifierName" "modifier_good_luck"
                    "Target" "CASTER"
                }
            }
            "OnFailure"
            {
                "Stun"
                {
                    "Target" "CASTER"
                    "Duration" "0.5"
                }
            }
        }
    }
}

"modifier_good_luck"
{
    "IsHidden" "1"
    "Properties"
    {
        "MODIFIER_PROPERTY_PREATTACK_CRITICALSTRIKE" "%crit_bonus"
    }

    "OnAttackLanded"
    {
        "RemoveModifier"
        {
            "ModifierName" "modifier_good_luck"
            "Target" "CASTER"
        }
    }
}
```

--------------------------------

### Install Babel loader dependencies

Source: https://moddota.com/panorama/webpack

Install babel-loader, @babel/core, and @babel/preset-react as dev dependencies to enable Babel processing for JavaScript files.

```shell
npm install -D babel-loader @babel/core @babel/preset-react
```

--------------------------------

### Define item properties in npc_items_custom.txt

Source: https://moddota.com/abilities/lua-item-tutorial

Sets up the item's base properties including ID, BaseClass, texture, script file, cast range, cast point, cooldown, and mana cost. The ID should be above 1250 to avoid conflicts.

```txt
"DOTAAbilities"
{
	"item_blink_staff"
	{
		"ID"							"1250" // anything above 1250 should be safe to use.
		"BaseClass"					"item_lua"
		"AbilityTextureName"			"item_blink_staff"
		"ScriptFile"					"lua_items/blink_staff/blink_staff.lua"
		// Casting
		//--------------------------------------------
		"AbilityCastRange"				"0" //We could define limit here but blink dagger has unlimited range to let player use it more efficiently. The range limiting comes in the script. 0 means unlimited.
		"AbilityCastPoint"				"0.3" //It's the wind up time of spell.
		"AbilityCooldown"				"10.0"
		"AbilityManaCost"				"50"
	}
}
```

--------------------------------

### Windows: Create junction for game folder

Source: https://moddota.com/tools/setting-up-your-addon-with-github

Creates a junction linking the game folder to the Dota addon directory. Run in an elevated command prompt. The output confirms the junction creation.

```shell
mklink /J "C:\Users\Veggiesama\Desktop\HVH\game\hunter_v_hunted\" "C:\Games\steamapps\common\dota 2 beta\game\dota_addons\hunter_v_hunted\"
# Junction created for C:\Users\Veggiesama\Desktop\HVH\game\hunter_v_hunted\ <<===>> C:\Games\steamapps\common\dota 2 beta\game\dota_addons\hunter_v_hunted\
```
Tokens:
Raw