Hand_Events.c File Reference

Data Structures
class	HandEventBase
	Abstracted event, not to be used, only inherited. More...
class	HandEventRemove
class	HandEventSwap
class	HandEventReplaceWithNewBase
class	HandEventDestroyAndReplaceWithNew

Variables
	JUNCTURE_NOT_REQUIRED
	JUNCTURE_ACQUIRED
	JUNCTURE_DENIED
	ERROR
enum	HandEventID {   UNKNOWN , TAKE , MOVETO , DROP ,   THROW , SWAP , FORCESWAP , DESTROY ,   CREATED , DESTROYED , REPLACE , REPLACE2 ,   REPLACE3 , REPLACED , HUMANCOMMAND_ACTION_FINISHED , HUMANCOMMAND_ACTION_ABORTED ,   ANIMEVENT_CHANGE_HIDE }
	events More...
enum	JunctureRequestResult
	m_EventID = 0
int	m_AnimationID = -1
DayZPlayer	m_Player
ref InventoryLocation	m_Src
bool	m_IsJuncture
bool	m_IsRemote
void	HandEventBase (Man p=null, InventoryLocation src=null)
HandEventID	GetEventID ()
bool	IsAuthoritative ()
bool	IsOwner ()
bool	IsProxy ()
void	ReadFromContext (ParamsReadContext ctx)
void	WriteToContext (ParamsWriteContext ctx)
InventoryLocation	GetSrc ()
InventoryLocation	GetSecondSrc ()
EntityAI	GetSrcEntity ()
EntityAI	GetSecondSrcEntity ()
InventoryLocation	GetDst ()
InventoryLocation	GetSecondDst ()
int	GetAnimationID ()
bool	AcquireInventoryJunctureFromServer (notnull Man player)
bool	CheckRequest ()
bool	CheckRequestEx (InventoryValidation validation)
bool	CanPerformEvent ()
bool	CanPerformEventEx (InventoryValidation validation)
bool	CheckRequestSrc ()
bool	IsServerSideOnly ()
static HandEventBase	HandEventFactory (HandEventID id, Man p=null, InventoryLocation src=null)
static HandEventBase	CreateHandEventFromContext (ParamsReadContext ctx)
string	DumpToString ()
bool	ReserveInventory ()
void	ClearInventoryReservation ()
HandEventBase	HandAnimEventFactory (WeaponEvents type, Man p=null, InventoryLocation src=null)

Enumeration Type Documentation

HandEventID

enum HandEventID

events

identifier for events mainly for rpc purposes

Enumerator
UNKNOWN
TAKE
MOVETO
DROP
THROW
SWAP	swapping from ground
FORCESWAP
DESTROY
CREATED
DESTROYED
REPLACE
REPLACE2
REPLACE3
REPLACED
HUMANCOMMAND_ACTION_FINISHED
HUMANCOMMAND_ACTION_ABORTED
ANIMEVENT_CHANGE_HIDE

JunctureRequestResult

enum JunctureRequestResult

Function Documentation

AcquireInventoryJunctureFromServer()

bool AcquireInventoryJunctureFromServer

(

notnull Man

player

)

CanPerformEvent()

bool CanPerformEvent

(

)

CanPerformEventEx()

bool CanPerformEventEx

(

InventoryValidation

validation

)

References HandEventBase::CanPerformEvent().

CheckRequest()

bool CheckRequest

(

)

CheckRequestEx()

bool CheckRequestEx

(

InventoryValidation

validation

)

Do not check for action validity on remotes or when performing through juncture. Juncture locks guarentee the item is safe to interact with and the server has validated the command at this point. Checking at this point is both wasteful and can result in a failure which leads to desync

References HandEventBase::CheckRequest(), InventoryValidation::m_IsJuncture, and InventoryValidation::m_IsRemote.

CheckRequestSrc()

bool CheckRequestSrc

(

)

Referenced by PlayerCheckRequestSrc().

ClearInventoryReservation()

void ClearInventoryReservation

(

)

References HandEventBase::GetDst(), InventoryLocation::GetItem(), and GetSrc().

Referenced by GameInventory::ClearInventoryReservationEx().

CreateHandEventFromContext()

static HandEventBase CreateHandEventFromContext ( ParamsReadContext  ctx )

static

References Error(), HandEventFactory(), OptionalLocationReadFromContext(), Serializer::Read(), and HandEventBase::ReadFromContext().

DumpToString()

string DumpToString

(

)

References InventoryLocation::DumpToStringNullSafe(), GetEventID(), and m_Src.

Referenced by HandEventBase::AcquireInventoryJunctureFromServer(), and DbgPrintTargetDump().

GetAnimationID()

int GetAnimationID

(

)

References m_AnimationID.

GetDst()

InventoryLocation GetDst

(

)

Referenced by HandEventBase::AcquireInventoryJunctureFromServer(), HandEventBase::CanPerformEvent(), and HandEventBase::DumpToString().

GetEventID()

HandEventID GetEventID

(

)

References m_EventID.

Referenced by HandEventBase::CanPerformEvent(), HandEventSwap::CanPerformEvent(), HandEventBase::CanPerformEventEx(), HandEventBase::CheckRequest(), HandEventSwap::CheckRequest(), HandEventBase::CheckRequestSrc(), DumpToString(), and HandEventBase::DumpToString().

GetSecondDst()

InventoryLocation GetSecondDst

(

)

GetSecondSrc()

InventoryLocation GetSecondSrc

(

)

GetSecondSrcEntity()

EntityAI GetSecondSrcEntity

(

)

GetSrc()

InventoryLocation GetSrc

(

)

References m_Src.

Referenced by HandEventBase::AcquireInventoryJunctureFromServer(), HandEventBase::CanPerformEvent(), HandEventBase::CanPerformEventEx(), HandEventBase::CheckRequest(), HandEventBase::CheckRequestSrc(), ClearInventoryReservation(), HandEventBase::DumpToString(), and ReserveInventory().

GetSrcEntity()

EntityAI GetSrcEntity

(

)

References InventoryLocation::GetItem(), and m_Src.

Referenced by HandEventRemove::CanPerformEventEx(), HandEventSwap::CheckRequest(), HandEventRemove::CheckRequestEx(), HandEventBase::GetDst(), and HandEventRemove::HandEventThrow().

HandAnimEventFactory()

HandEventBase HandAnimEventFactory	(	WeaponEvents	type,
		Man	p = null,
		InventoryLocation	src = null
	)

Referenced by HandleInventory().

HandEventBase()

void HandEventBase	(	Man	p = null,
		InventoryLocation	src = null
	)

References Class::CastTo(), and m_Src.

HandEventFactory()

static HandEventBase HandEventFactory ( HandEventID  id, Man  p = null, InventoryLocation  src = null  )

static

References Error(), HandEventBase::HandAnimEventChanged(), HandEventBase::HandEventCreated(), HandEventBase::HandEventDestroy(), HandEventBase::HandEventDestroyed(), HandEventBase::HandEventHumanCommandActionAborted(), HandEventBase::HandEventHumanCommandActionFinished(), HandEventBase::HandEventMoveTo(), HandEventBase::HandEventReplaced(), and HandEventBase::HandEventTake().

Referenced by CreateHandEventFromContext().

IsAuthoritative()

bool IsAuthoritative

(

)

Referenced by HandEventRemove::CheckRequestEx().

IsOwner()

bool IsOwner

(

)

Referenced by Car::IsServerOrOwner(), and Car::OnVariablesSynchronized().

IsProxy()

bool IsProxy

(

)

Referenced by BoatScript::EEHitBy(), BoatScript::EOnPostSimulate(), BoatScript::EOnSimulate(), and BoatScript::OnContact().

IsServerSideOnly()

bool IsServerSideOnly

(

)

ReadFromContext()

void ReadFromContext

(

ParamsReadContext

ctx

)

ReserveInventory()

bool ReserveInventory

(

)

References GameInventory::c_InventoryReservationTimeoutShortMS, HandEventBase::GetDst(), InventoryLocation::GetItem(), and GetSrc().

WriteToContext()

void WriteToContext

(

ParamsWriteContext

ctx

)

References m_AnimationID, m_EventID, m_Src, OptionalLocationWriteToContext(), and Serializer::Write().

Variable Documentation

ERROR

@ ERROR

JUNCTURE_ACQUIRED

JUNCTURE_ACQUIRED

JUNCTURE_DENIED

JUNCTURE_DENIED

JUNCTURE_NOT_REQUIRED

JUNCTURE_NOT_REQUIRED

m_AnimationID

int m_AnimationID = -1

Referenced by GetAnimationID(), and WriteToContext().

m_EventID

m_EventID = 0

Referenced by GetEventID(), HandEventBase::HandAnimEventChanged(), HandEventBase::HandEvengReplaceWithNewBase(), HandEventBase::HandEventCreated(), HandEventBase::HandEventDestroy(), HandEventReplaceWithNewBase::HandEventDestroyAndReplaceWithNew(), HandEventDestroyAndReplaceWithNew::HandEventDestroyAndReplaceWithNewElsewhere(), HandEventBase::HandEventDestroyed(), HandEventReplaceWithNewBase::HandEventDestroyElsewhereAndReplaceWithNewInHands(), HandEventRemove::HandEventDrop(), HandEventSwap::HandEventForceSwap(), HandEventBase::HandEventHumanCommandActionAborted(), HandEventBase::HandEventHumanCommandActionFinished(), HandEventBase::HandEventMoveTo(), HandEventBase::HandEventReplaced(), HandEventBase::HandEventSwap(), HandEventBase::HandEventTake(), HandEventRemove::HandEventThrow(), and WriteToContext().

m_IsJuncture

bool m_IsJuncture

For action guards. Although we can guarantee the item will exist for remotes and juncture, we can't guarantee the conditions will be the same as when the action was first performed. So therefore we only perform maximal checks on the Client and then Server but then do minimal checks on Juncture-Client and Juncture-Server and no checks on Remote-Client.

m_IsRemote

bool m_IsRemote

m_Player

DayZPlayer m_Player

m_Src

ref InventoryLocation m_Src

Referenced by HandEventBase::AcquireInventoryJunctureFromServer(), HandEventSwap::CanPerformEvent(), HandEventBase::CheckAndExecuteForceStandUp(), HandEventBase::CheckRequest(), HandEventSwap::CheckRequest(), DumpToString(), HandEventBase::DumpToString(), GetSrc(), GetSrcEntity(), HandEventBase(), HandStartAction::HandTakingAnimated_Show(), HandStartAction::OnAbort(), OnEntry(), HandStartAction::OnEntry(), HandStartAction::OnExit(), OnUpdate(), and WriteToContext().