Changes between Version 17 and Version 18 of Aura_Templates


Ignore:
Timestamp:
May 22, 2017, 9:45:36 PM (7 years ago)
Author:
Sandarac
Comment:

Update to r19519, and fix some grammar.

Legend:

Unmodified
Added
Removed
Modified

  • Aura_Templates

    v17 v18  
    1 The auras can be used on an entity by creating an aura json like this:
     1An aura can be specified for an entity by creating an aura json like this:
    22
    33{{{
    44#!js
    55{
    6     type: range,
    7     radius: 60,
    8     affects: ["Worker"],
    9     modifications: [
    10         {value: "Builder/Rate", multiply: 1.15}
     6    "type": "range",
     7    "radius": 60,
     8    "affects": ["Worker"],
     9    "modifications": [
     10        {"value": "Builder/Rate", "multiply": 1.15}
    1111    ],
    12     auraName: "Builder Aura",
    13     auraDescription: "Buildings construct 15% faster within his vision.",
    14     overlayIcon: "art/textures/ui/session/auras/build_bonus.png"
     12    "auraName": "Builder Aura",
     13    "auraDescription": "Buildings construct 15% faster within his vision.",
     14    "overlayIcon": "art/textures/ui/session/auras/build_bonus.png",
     15    "rangeOverlay" : {
     16        "lineTexture": "outline_border.png",
     17        "lineTextureMask": "outline_border_mask.png",
     18        "lineThickness": 0.075
     19    }
    1520}
    1621}}}
    1722
    18 The '''type''' can currently be '''range, global, player, formation, garrison or garrisonedUnits'''. The range type also requires an extra Radius (as in the example), all entities in this radius will be affected by the aura. Global auras work on all entities (like technologies, but the working is reverted when the entity with an aura dies). Global and range auras also affect the unit itself when applicable. Player aura affects the Player entity. Formation auras affect all members of the same formation as the unit. The garrison aura has an effect on the garrisoning structure (arrows the structure shoots, speed of a ship, ...). And as last one, the garrisonedUnits aura influences the units that are visibly garrisoned (giving units on a wall extra armor f.e.).
     23The '''type''' can currently be '''range, global, player, formation, garrison or garrisonedUnits'''. The range type also requires an extra Radius (as in the example), and all entities in this radius will be affected by the aura. Global auras work on all entities (like technologies, but the modifications are reverted when the entity with an aura dies). Global and range auras also affect the unit itself when applicable. Player auras affects the Player entity. Formation auras affect all members of the same formation as the unit. The garrison aura has an effect on the garrisoning structure (arrows the structure shoots, speed of a ship, ...). The garrisonedUnits aura influences the units that are visibly garrisoned (giving units on a wall extra armor f.e.).
    1924
    2025
    … …  
    2328'''affectedPlayers''' defines on which players it will act (a hero might cause the enemy to have less armour), listed as ["Value1", "Value2"]. The possible values are '''Player''' (yourself), '''Ally''', '''!ExclusiveAlly''', '''!MutualAlly''', '''!ExclusiveMutualAlly''' or '''Enemy'''. This value defaults to [ "'''Player'''" ] .
    2429
    25 '''modifications''' are list of modifications that will be applied. Similarly structured as with technologies. A modification consists out of key, which presents the name of the value that will be changed, and either '''add''' or '''multiply''' to resp. add or multiply the value of the affected entity with something. Note that the actions should be reversible (they are reversed when the aura carrying entity is killed), so multiplications with 0 are not allowed. All other values are supported.
     30'''modifications''' are a list of modifications that will be applied, similarly structured as with technologies. A modification consists of a key, which presents the name of the value that will be changed, and either '''add''' or '''multiply''' to resp. add or multiply the value of the affected entity with something. Note that the actions should be reversible (they are reversed when the aura carrying entity is killed), so multiplications with 0 are not allowed. All other values are supported.
    2631
    2732The list of modifiable unit properties is the same as with the Technologies (see TechModifications).
    … …  
    3136'''auraDescription''' is not mandatory, it will appear in various UI elements.
    3237
    33 '''overlayIcon''' is the icon showed above all affected entity's.
     38'''overlayIcon''' is the icon displayed above all affected entities.
    3439
    3540'''requiredTechnology''' is a technology required for the aura to be available.
    3641
    37 '''stackable''' is an optional boolean which allow the aura to be stackable when set to true.
     42'''stackable''' is an optional boolean which allows the aura to be stackable when set to true.
     43
     44'''rangeOverlay''' is an optional Object for auras with a '''range''' type. If present in the aura json, it must consist of the properties "lineTexture", "lineTextureMask", and "lineThickness". The values for both "lineTexture" and "lineTextureMask" must be a string of the full filename of a png file under `binaries/data/mods/public/art/textures/selection/`. "lineThickness" must be a number (typically 0.05 to 0.3). If '''rangeOverlay''' is not present for an aura with a range type, the range visualization for that aura will use default values for these three properties (currently "outline_border.png", "outline_border_mask.png", and 0.2 respectively).