Tutorial 1–2 - BLKTower/TestWiki GitHub Wiki
In this tutorial, we will be adding a ranged weapon to the unit we created in the previous tutorial. Weapons allow units to auto-attack other units.
This tutorial will cover:
1. Creating A Missile Unit
Create a new unit named "Hero IceMage Weapon Missile" and set its Parent to "_CMissile. The names don't really matter (except when creating a unit and unit actor—those names must match), but we use a general naming pattern that helps keep large projects organized.
As with the hero, the actor for the projectile is automatically created. Set the actor's Resource Type to "ParticleAnimation" and the Resource Name to "vfx_icemage_weapon_missile".
2. Creating Effects
Navigate to the Effect tab and create a new effect. Name it "Hero IceMage Weapon Damage". Set the Effect Type to "damage", and the Damage Amount to "5". You'll notice there's a Which Unit field that we're leaving it set to the default value of "Target Unit". This means that the effect is run on the target unit of the previous effect (or weapon/ability that creates this effect).
Next create another new effect and name it "Hero IceMage Weapon Launch". Make sure the Effect Type is set to "Launch Missile" (which is the default). Set the Missile Unit to the missile unit we created (Hero IceMage Weapon Missile). Set the Impact Effect as the damage effect we created (Hero IceMage Weapon Damage). Leave the rest as the default values.
Notice the Object Explorer. Our Weapon Missile unit and Weapon Damage effect are now both associated with our Weapon Launch effect. We made a connection between the two effects when we set them in the Field Editor.
3. Creating A Mover
Now select the Mover tab and create a new mover. As the name implies, Movers help determine how other objects/units move.
This time, let's use a template by setting the Template field to "Standard Ballistic Missile". Using a template is similar to using a Parent field, except the data is only copied once (when the new object is created), and not updated if the parent value changes. Let's name it "Hero IceMage Weapon Missile" since this mover will determine how that missile moves.
There are a few different mover types: ballistic, guidance, sineWave, and orbiting. Ballistic movers move in an arc controlled by the mover's gravity and flight time. Guidance movers move in a straight line towards their target at a rate controlled by the mover's speed and acceleration. SineWave movers move with periodic bounces. Orbiting movers mode in a continuous orbit around an object.
Next, go back to your Launch Missile effect, and set the Mover field as the Mover we just created.
4. Creating A Weapon
Now go to the Weapon tab and create a new weapon. Name it "Hero IceMage Weapon" and set the Parent to "_StandardRangedWeapon". Then set the Effect Name to your launch missile effect (Hero IceMage Weapon Launch).
Finally, go back to the unit tab and select your hero unit. Scroll down to "Components" > "Behavior" > "Generic Controllable Unit" and ensure the Leash Radius is set to "30" to let our hero see the enemies before they see him. Then add the weapon we created to the hero's Weapon List.
Because of this connection, we can see that our weapon hierarchy has been added to our unit's hierarchy in the Object Explorer, making it easier to identify which effects/movers/actors are connected together.
To test that our new weapon works, we have to add some enemies for our hero to fight! Head back to the terrain editor and under the unit tab, set the current unit to "Standard MeleeUnit" and place a few on the terrain nearby to your hero. Make sure they are far enough that they don't attack your hero, but still close enough where your hero can attack them.
By default, units placed on the map belong to the player's team (and thus the hero won't attack them by default). We can remedy this by changing the value of "Selected Unit Team" for each enemy unit from "1" to "-1". You would change this value to "2" if the game was multiplayer with player vs. player.
Change to selection mode by pressing the "ESC" key or clicking on the mouse icon at the top left of the units panel. Select each of the melee units and change their UnitTeam from "Player" (1) to "Enemy" (-1). Make sure to do this for every enemy unit - box selecting and updating the value doesn't work.
Finally, SAVE and hit Play to see our new weapon in action!
Tutorial Map: Tutorial 1–2 Weapon