Implementing Shooting

1. For every wall's box surface enable the 7th bit of the Intersection Mask, and call it BulletIntersection.

   

2. Create a new C++ component in an IDE and call it Projectile. Copy the following code to the corresponding files and save the solution.

   Projectile.h (C++)

   #pragma once
   #include <UnigineComponentSystem.h>
   
   #include <UnigineGame.h>
   
   class Projectile : public Unigine::ComponentBase
   {
   public:
   	// declare constructor and destructor for our class and define a property name. 
   	COMPONENT_DEFINE(Projectile, ComponentBase)
   	// declare methods to be called at the corresponding stages of the execution sequence
   	COMPONENT_INIT(init);
   	COMPONENT_UPDATE(update);
   
   	PROP_PARAM(File, bulletHitEffect);
   
   protected:
   	void init();
   	void update();
   
   private:
   	// speed of the bullet
   	float speed = 30.0f;
   
   	Unigine::WorldIntersectionNormalPtr intersection;
   };

   Projectile.cpp (C++)

   #include "Projectile.h"
   #include "Destroy.h"
   
   REGISTER_COMPONENT(Projectile);
   
   using namespace Unigine;
   using namespace Math;
   
   void Projectile::init()
   {
   	if (intersection == nullptr)
   		intersection = WorldIntersectionNormal::create();
   }
   
   void Projectile::update()
   {
   	Vec3 oldPos = node->getWorldPosition();
   	vec3 dir = node->getWorldDirection(MathLib::AXIS::AXIS_Y);
   
   	// calculate the next position of the bullet
   	Vec3 newPos = oldPos + Vec3(dir) * speed * Game::getIFps();
   
   	// check the intersection with wall objects
   	Unigine::ObjectPtr obj = World::getIntersection(oldPos, newPos, 0x00000080, intersection); // 7th BulletIntersection bit is set
   	if (obj)
   	{
   		// spawn the hit effect at the hit point
   		NodePtr hitEffect = World::loadNode(bulletHitEffect);
   		if (hitEffect)
   		{
   			hitEffect->setPosition(intersection->getPoint());
   			// orient the effect towards the hit direction 
   			hitEffect->setWorldDirection(intersection->getNormal(), vec3_up, AXIS::AXIS_Y);
   		}
   
   		// add impulse to an object if it is a body rigid 
   		BodyRigidPtr rb = obj->getBodyRigid();
   		if (rb)
   		{
   			rb->setFrozen(false);
   			rb->addWorldImpulse(obj->getWorldPosition(), node->getWorldDirection(MathLib::AXIS::AXIS_Y) * speed);
   		}
   
   		// remove the bullet
   		node->deleteLater();
   	}
   	else
   	{
   		// move the bullet to a new position
   		node->setWorldPosition(newPos);
   	}
   }

3. As the Life Time of the bullet runs out we should delete it by simply calling the deleteLater() method. Create a new C++ component and call it Destroy. Copy the code below and paste it to the corresponding files in your project and save them in your IDE.

   Destroy.h (C++)

   #pragma once
   #include <UnigineComponentSystem.h>
   #include <UnigineGame.h>
   
   class Destroy : public Unigine::ComponentBase
   {
   public:
   	// declare constructor and destructor for our class and define a property name. 
   	COMPONENT_DEFINE(Destroy, ComponentBase)
   	// declare methods to be called at the corresponding stages of the execution sequence
   	COMPONENT_INIT(init);
   	COMPONENT_UPDATE(update);
   
   	// object's lifetime
   	PROP_PARAM(Float, lifeTime);
   
   protected:
   	void init();
   	void update();
   
   private:
   	float startTime;
   };

   Destroy.cpp (C++)

   #include "Destroy.h"
   
   using namespace Unigine;
   using namespace Math;
   
   REGISTER_COMPONENT(Destroy);
   
   void Destroy::init()
   {
   	// remember initialization time of an object
   	startTime = Game::getTime();
   }
   
   void Destroy::update()
   {
   	// wait until the life time ends and delete the object
   	if (Game::getTime() - startTime > lifeTime)
   		node->deleteLater();
   }

4. Build and run the project via an IDE (press Ctrl + F5 in Visual Studio), the Component System will generate a property-file for the component.

5. Drag programming_quick_start\character\bullet\bullet.node from the Asset Browser into the Viewport and click Edit in the Reference section of the Parameters window to make modifications. Add a Destroy component to the child ObjectMeshStatic bullet node and set the Life Time to 5.0.

   

6. Next, drag the programming_quick_start\character\bullet_hit\bullet_hit.node from the Asset Browser into the Viewport, click Edit in the Parameters window, add the Destroy property to the bullet_hit's NodeDummy and to the LightOmni. Set Life Time values to 10.0 and 0.05 seconds respectively.

   

7. Then select the bullet_hit Node Reference and click Apply in the Reference section to save all changes made to it.

8. Add a Projectile property to the child ObjectMeshStatic bullet of the bullet Node Reference. Drag the bullet_hit.node node from the Asset Browser window to the Bullet Hit Effect field.

   

   There is also the Speed field that allows specifying a spawn speed for the bullet.

9. Now disable Intersection detection for the bullet to avoid the bullet detecting intersections with itself. Select the bullet_mat surface and uncheck the Intersection option for it.
10. Save changes to the bullet Node Reference, by selecting it and clicking Apply in the Reference section or simply press Ctrl+S hotkey to save all changed assets.
11. Now you can delete the bullet and bullet_hit nodes from the world as we will spawn it via code.

Let's create special spawn nodes using Dummy Nodes with no visual representation. Their positions will be used as initial bullet positions.

1. Select the robot Node Reference in the World Nodes window and click Edit in the Reference section of the Parameters window.
2. Right-click on the child robot ObjectMeshSkinned in the World Nodes window to add a child node. Choose Create->Node->Dummy and position it in the Viewport near the end of the left gun. The Y axis (green arrow) must point in the fire direction, since Unigine uses the right-handed Cartesian coordinate system.

3. Rename the Dummy Node as "left_bullet_spawn".

   

4. Create a spawn point for the right gun the same way and call it "right_bullet_spawn".

5. To spawn bullets at run-time via API on Right Mouse Button click, add the following code to the PlayerController component. We use the file parameter of the property to reference the bullet node. Don't forget to save your code in an IDE.

   PlayerController.h (C++)

   #pragma once
   #include <UnigineComponentSystem.h>
   
   #include <UnigineGame.h>
   #include <UnigineControls.h>
   #include <UnigineStreams.h>
   #include <UniginePlayers.h>
   #include <UnigineWorld.h>
   #include <UnigineConsole.h>
   #include <UnigineMathLib.h>
   #include <UnigineRender.h>
   
   class PlayerController : public Unigine::ComponentBase
   {
   public:
   	// declare constructor and destructor for our class and define a property name. 
   	COMPONENT_DEFINE(PlayerController, ComponentBase)
   	// declare methods to be called at the corresponding stages of the execution sequence
   	COMPONENT_INIT(init); 
   	COMPONENT_UPDATE_PHYSICS(updatePhysics);
   //========================== NEW - BEGIN ===============================
   	COMPONENT_UPDATE(update);
   
   	// asset file that contains the bullet
   	PROP_PARAM(File, bullet_path);
   	// nodes in the world for bullets' spawn
   	PROP_PARAM(Node, leftSpawn);
   	PROP_PARAM(Node, rightSpawn);
   //========================== NEW - END ===============================
   
   protected:
   	void init();
   	void updatePhysics();
   //========================== NEW - BEGIN ===============================
   	void update();
   //=========================== NEW - END ================================
   
   private:
   	void move(const Unigine::Math::vec3& direction);
   
   	Unigine::BodyRigidPtr rigid;
   
   	Unigine::PlayerPtr player;
   
   	// a WorldIntersection object to store the information about the intersection
   	Unigine::WorldIntersectionPtr intersection = Unigine::WorldIntersection::create();
   
   	Unigine::Math::Vec3 pos;
   //========================== NEW - BEGIN ===============================
   	bool isNextLeft = false;
   
   	// mouse fire button 
   	Unigine::Input::MOUSE_BUTTON mouseFireKey = Unigine::Input::MOUSE_BUTTON::MOUSE_BUTTON_RIGHT;
   
   	Unigine::NodePtr bullet;
   //=========================== NEW - END ================================
   
   };

   PlayerController.cpp (C++)

   #include "PlayerController.h"
   //========================== NEW - BEGIN ===============================
   #include "Projectile.h"
   #include "Destroy.h"
   //========================== NEW - END ===============================
   using namespace Unigine;
   using namespace Math;
   
   REGISTER_COMPONENT(PlayerController);
   
   void PlayerController::init()
   {
   	player = Game::getPlayer();
   
   	if (node)
   	{
   		rigid = node->getObjectBodyRigid();
   		if (rigid)
   		{
   			rigid->setAngularScale(vec3(0.0f, 0.0f, 0.0f)); // restricting the rotation
   			rigid->setLinearScale(vec3(1.0f, 1.0f, 0.0f)); // restricting Z movement
   			rigid->setMaxLinearVelocity(8.0f); // clamping the max linear velocity
   		}
   
   	}
   }
   //========================== NEW - BEGIN ===============================
   void PlayerController::update()
   {
   	if (Input::isMouseButtonDown(mouseFireKey) && !Console::isActive())
   	{
   		// load the bullet and set its position 
   		bullet = World::loadNode(bullet_path);
   
   		if (isNextLeft && bullet)
   		{
   			if (rightSpawn)
   			{
   				bullet->setPosition(rightSpawn->getWorldPosition());
   				bullet->setRotation(rightSpawn->getWorldRotation());
   			}
   		}
   		else
   		{
   			if (leftSpawn)
   			{
   				bullet->setPosition(leftSpawn->getWorldPosition());
   				bullet->setRotation(leftSpawn->getWorldRotation());
   			}
   		}
   		// alternate between the left and the right gun
   		isNextLeft = !isNextLeft;
   	}
   
   	// press ESC button to close the game
   	if (Input::isKeyDown(Input::KEY::KEY_ESC))
   	{
   		Engine::get()->quit();
   	}
   }
   //=========================== NEW - END ================================
   
   void PlayerController::updatePhysics()
   {
   	if (!Console::isActive())  // do not process input if the console is shown
   	{
   		// check if W key is pressed
   		if (Input::isKeyPressed(Input::KEY::KEY_W))
   			move(player->getWorldDirection(MathLib::AXIS::AXIS_Y)); // move forward
   
   		// check if S key is pressed
   		if (Input::isKeyPressed(Input::KEY::KEY_S))
   			move(player->getWorldDirection(MathLib::AXIS::AXIS_NY)); // move backward
   
   		// check if A key is pressed
   		if (Input::isKeyPressed(Input::KEY::KEY_A))
   			move(player->getWorldDirection(MathLib::AXIS::AXIS_NX)); // move left
   
   		// check if D key is pressed
   		if (Input::isKeyPressed(Input::KEY::KEY_D))
   			move(player->getWorldDirection(MathLib::AXIS::AXIS_X)); // move right
   
   		// finding the positions of the cursor and the point moved 100 units away in the camera forward direction 
   		ivec2 mouse = Input::getMousePosition();
   		Vec3 p0 = player->getWorldPosition();
   
   		Vec3 p1 = p0 + Vec3(player->getDirectionFromMainWindow(mouse.x, mouse.y)) * 100;
   
   		// casting a ray from p0 to p1 to find the first intersected object
   		ObjectPtr obj = World::getIntersection(p0, p1, 1, intersection); // the first bit of the intersection mask is set to 1, the rest are 0s
   
   		// finding the intersection position, creating a transformation matrix to face this position and setting the transform matrix for the body preserving current angular and linear velocities
   		if (obj && rigid)
   		{
   			pos = intersection->getPoint();
   			pos.z = rigid->getTransform().getTranslate().z; // project the position vector to the Body Rigid pivot plane
   			Mat4 transform = Math::setTo(rigid->getTransform().getTranslate(), pos, vec3_up, AXIS::AXIS_Y);
   			rigid->setPreserveTransform(transform); // turn the character's body
   		}
   	}
   }
   
   // moving the rigid body with linear impulse in the specified direction
   void PlayerController::move(const Unigine::Math::vec3& direction)
   {
   	// direction is a normalized camera axis vector 
   	if (rigid)
   		// direction is a normalized camera axis vector 
   		rigid->addLinearImpulse(direction);
   }

6. Build and run the solution in your IDE to regenerate the PlayerController property.

7. Drag left_bullet_spawn, and right_bullet_spawn to the corresponding fields of the PlayerController property of the robot node (ObjectMeshSkinned). And assign the bullet.node to the Bullet Path field.

   

8. Save changes to the world, go to File->Save World or press Ctrl+S hotkey.
9. Build and run the game in your IDE to try out the new shooting ability.