DOOM-3-BFG/neo/d3xp/PredictedValue_impl.h

/*
===========================================================================

Doom 3 BFG Edition GPL Source Code
Copyright (C) 1993-2012 id Software LLC, a ZeniMax Media company. 

This file is part of the Doom 3 BFG Edition GPL Source Code ("Doom 3 BFG Edition Source Code").  

Doom 3 BFG Edition Source Code is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Doom 3 BFG Edition Source Code is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Doom 3 BFG Edition Source Code.  If not, see <http://www.gnu.org/licenses/>.

In addition, the Doom 3 BFG Edition Source Code is also subject to certain additional terms. You should have received a copy of these additional terms immediately following the terms and conditions of the GNU General Public License which accompanied the Doom 3 BFG Edition Source Code.  If not, please request a copy in writing from id Software at the address below.

If you have questions concerning this license or the applicable additional terms, you may contact in writing id Software LLC, c/o ZeniMax Media Inc., Suite 120, Rockville, Maryland 20850 USA.

===========================================================================
*/
#ifndef PREDICTED_VALUE_IMPL_H_
#define PREDICTED_VALUE_IMPL_H_

#include "PredictedValue.h"
#include "Player.h"

/*
===============
idPredictedValue::idPredictedValue
===============
*/
template< class type_ >
idPredictedValue< type_ >::idPredictedValue() :
	value(),
	clientPredictedMilliseconds( 0 ) {
}

/*
===============
idPredictedValue::idPredictedValue
===============
*/
template< class type_ >
idPredictedValue< type_ >::idPredictedValue( const type_ & value_ ) :
	value( value_ ),
	clientPredictedMilliseconds( 0 ) {
}

/*
===============
idPredictedValue::UpdatePredictionTime
===============
*/
template< class type_ >
void idPredictedValue< type_ >::UpdatePredictionTime() {
	if ( gameLocal.GetLocalPlayer() != NULL ) {
		clientPredictedMilliseconds = gameLocal.GetLocalPlayer()->usercmd.clientGameMilliseconds;
	}
}

/*
===============
idPredictedValue::Set
===============
*/
template< class type_ >
void idPredictedValue< type_ >::Set( const type_ & newValue ) {
	value = newValue;
	UpdatePredictionTime();
}

/*
===============
idPredictedValue::operator=
===============
*/
template< class type_ >
idPredictedValue< type_ > & idPredictedValue< type_ >::operator=( const type_ & newValue ) {
	Set( newValue );
	return *this;
}

/*
===============
idPredictedValue::operator+=
===============
*/
template< class type_ >
idPredictedValue< type_ > & idPredictedValue< type_ >::operator+=( const type_ & toAdd ) {
	Set( value + toAdd );
	return *this;
}

/*
===============
idPredictedValue::operator-=
===============
*/
template< class type_ >
idPredictedValue< type_ > & idPredictedValue< type_ >::operator-=( const type_ & toSubtract ) {
	Set( value - toSubtract );
	return *this;
}

/*
===============
idPredictedValue::UpdateFromSnapshot

Always updates the value for remote clients.

Only updates the actual value if the snapshot usercmd frame is newer than the one in which
the client predicted this value.

Returns true if the value was set, false if not.
===============
*/
template< class type_ >
bool idPredictedValue< type_ >::UpdateFromSnapshot( const type_ & valueFromSnapshot, int clientNumber ) {
	if ( clientNumber != gameLocal.GetLocalClientNum() ) {
		value = valueFromSnapshot;
		return true;
	}
		
	if ( gameLocal.GetLastClientUsercmdMilliseconds( clientNumber ) >= clientPredictedMilliseconds ) {
		value = valueFromSnapshot;
		return true;
	}

	return false;
}

/*
===============
operator==

Overload for idPredictedValue.
We only care if the values are equal, not the frame number.
===============
*/
template< class firstType_, class secondType_ >
bool operator==( const idPredictedValue< firstType_ > & lhs, const idPredictedValue< secondType_ > & rhs ) {
	return lhs.Get() == rhs.Get();
}

/*
===============
operator!=

Overload for idPredictedValue.
We only care if the values are equal, not the frame number.
===============
*/
template< class firstType_, class secondType_ >
bool operator!=( const idPredictedValue< firstType_ > & lhs, const idPredictedValue< secondType_ > & rhs ) {
	return lhs.Get() != rhs.Get();
}

/*
===============
operator==

Overload for idPredictedValue.
We only care if the values are equal, not the frame number.
===============
*/
template< class firstType_, class secondType_ >
bool operator==( const idPredictedValue< firstType_ > & lhs, const secondType_ & rhs ) {
	return lhs.Get() == rhs;
}

/*
===============
operator==

Overload for idPredictedValue.
We only care if the values are equal, not the frame number.
===============
*/
template< class firstType_, class secondType_ >
bool operator==( const firstType_ lhs, const idPredictedValue< secondType_ > & rhs ) {
	return lhs == rhs.Get();
}

/*
===============
operator!=

Overload for idPredictedValue.
We only care if the values are equal, not the frame number.
===============
*/
template< class firstType_, class secondType_ >
bool operator!=( const idPredictedValue< firstType_ > & lhs, const secondType_ & rhs ) {
	return lhs.Get() != rhs;
}

/*
===============
operator!=

Overload for idPredictedValue.
We only care if the values are equal, not the frame number.
===============
*/
template< class firstType_, class secondType_ >
bool operator!=( const firstType_ lhs, const idPredictedValue< secondType_ > & rhs ) {
	return lhs != rhs.Get();
}




#endif