Stun Player

If you want to completely stop the player from moving, you could remove the key bindings so they do nothing. However that doesn't work in all cases. A better way is to modify the engine so that the players are guaranteed to not be able to move.

Developed in TGE 1.5.2

The pros:
-Can still use the keyboard for other functions (e.g. console, exit game, etc.)

The cons:
-Can still use the keyboard for other functions (e.g. casting a spell)

First, in shapeBase.h

class ShapeBase : public GameBase
{
   typedef GameBase Parent;
   friend class ShapeBaseConvex;
   friend class ShapeBaseImageData;
   friend void physicalZoneFind(SceneObject*, void *);

public:
		[b]bool mStunned;   //are we stunned or NOT?[/b]

...

	  ServerIdMask    = Parent::NextFreeMask << 8,
[b]	  StunMask        = Parent::NextFreeMask << 9,
	  SoundMaskN      = Parent::NextFreeMask << 10,       ///< Extends + MaxSoundThreads bits
[/b]

...

   /// Returns damage amount.
   S32  getDamageLevel()  { return mDamage; }

[b]   //the stun structure
   void setStunState(bool stunned);
   bool isStunned() { return mStunned; }[/b]

Then, over in shapeBase.cc:

In the constructor (ShapeBase::ShapeBase()):

[b]mStunned = false;[/b]

After function void ShapeBase::onCollision(ShapeBase* object,VectorF vec) add this function:

//1 is stunned, 0 is not.
void ShapeBase::setStunState(bool stunned)
{
   if (stunned == mStunned)
      return;
   setMaskBits(StunMask);

   mStunned = stunned;
}

In ShapeBase::packUpdate:

Change this line:

if(!stream->writeFlag(mask & (NameMask | DamageMask | SoundMask |
         ThreadMask | ImageMask | CloakMask | MountedMask | InvincibleMask |
		 ShieldMask | SkinMask | ServerIdMask)))
      return retMask;


to this:

if(!stream->writeFlag(mask & (NameMask | DamageMask | SoundMask |
         ThreadMask | ImageMask | CloakMask | MountedMask | InvincibleMask |
		 ShieldMask | SkinMask | ServerIdMask [b]| StunMask[/b])))
      return retMask;

Right below that, add this:

[b]if (stream->writeFlag(mask & StunMask)) {
	   stream->writeFlag(mStunned);
}[/b]

In ShapeBase::unpackUpdate, add these lines:

if(!stream->readFlag())
         return;

[b]	if (stream->readFlag()) {
		setStunState(stream->readFlag());
        }[/b]

Then down by all the other console functions, add these two functions:

ConsoleMethod( ShapeBase, setStun, void, 3, 3, "(bool isStunned)")
{
   object->setStunState(dAtob(argv[2]));
}

ConsoleMethod( ShapeBase, isStunned, bool, 2, 2, "")
{
	return object->isStunned();
}

Now, we have successfully added a stunned variable to the shapebase class. Good. But it doesn't do anything yet. Go to player.cc.

In Player::updateMove, change these lines:

// Trigger images
   if (mDamageState == Enabled [b]&& mStunned == false[/b]) {
      setImageTriggerState(0,move->trigger[0]);
      setImageSecondTriggerState(0,move->trigger[1]);
[b]   } else if (mDamageState == Enabled && mStunned == true) {
      setImageTriggerState(0,0);
      setImageSecondTriggerState(0,0);[/b]
   }

...

   // Update current orientation
   if (mDamageState == Enabled [b]&& mStunned == false[/b]) {

...

   // Desired move direction & speed
   VectorF moveVec;
   F32 moveSpeed;
   if (mState == MoveState && mDamageState == Enabled [b]&& mStunned == false[/b])

What these last three changes will do is ignore inputs to Move, Rotate the camera (aim) and Shoot when the player is stunned. Build it and you should be set.

To stun a player, call %player.setStunState(1); and to unstun, call %player.setStunState(0);