dota-ability-tooltip
TypeScript icon, indicating that this package has built-in type declarations

0.0.7 • Public • Published

Dota Ability Tooltip

npm version size

Description

A small script that allows you to replace the standard dota 2 ability tooltips with custom ones.

Image alt

Prepare

  1. Install Node.js (You need LTS version)
  2. Install Vs Code

Getting Started

Variant 1

  1. Open Terminal in Vs Code (default Ctrl+Shift+`)
  2. Install package (enter command in terminal) npm i dota-ability-tooltip
  3. Enter command in terminal npm run build after that will be generated file build/index.js
  4. Copy this file build/index.js in our panorama/scripts...
  5. Include index.js in XML
 <scripts>
        <!-- Included JS script files go here -->
        <include src="file://{resources}/scripts/custom_game/index.js" />
    </scripts>

    <script>
        const config = {
            xmlTooltip: 'TOOLTIP PATH'
        }
        AbilitiesTooltipInject(config)
    </script>

Varian 2

  1. Open Terminal in Vs Code (default Ctrl+Shift+`)
  2. Install package (enter command in terminal) npm i dota-ability-tooltip
  3. Importing method registerAbilitiesTooltip from package. template

For Development

  1. Run command npm run dev

Parametrs

interface TooltipConfig {
    // The function that displays the custom tooltip 
    // Return true to show custom tooltip
    // Not necessarily
    isShown?: (abilityIndex: AbilityEntityIndex) => boolean;
    // Path to XML file custom tooltip
    // @example "file://{resources}/layout/custom_game/tooltips/towers_tooltip.xml"
    xmlTooltip: string;
    // Event on show custom tooltip
    // Not necessarily
    onShown?: (parentPanel: Panel, abilityEntityIndex: AbilityEntityIndex) => void;
}

Feature

  1. Add tooltips for items

Contents

  • [packages/DotaAbilityTooltip] - source code
  • [game | content] - for only development
  • [example] - example

Package Sidebar

Install

npm i dota-ability-tooltip

Weekly Downloads

1

Version

0.0.7

License

none

Unpacked Size

8.69 kB

Total Files

5

Last publish

Collaborators

  • happyfeedfriends