Entity Class Reference

Protected Member Functions
float	ConvertNonlethalDamage (float damage, DamageType damageType)
float	ConvertNonlethalDamage (float damage)
	DEPRECATED - for legacy purposes.
DamageZoneMap	GetEntityDamageZoneMap ()
map< int, string >	GetEntityDamageDisplayNameMap ()
bool	CanDisplayWeight ()
	'displayWeight' in item config
void	Log (string msg, string fnc_name="n/a")
	Log.
void	LogWarning (string msg, string fnc_name="n/a")
	LogWarning.
void	LogError (string msg, string fnc_name="n/a")
	LogError.
bool	HasFlammableMaterial ()
	Override this method to return TRUE when this item has or can provide fire. Evaluated on server and client.
bool	CanBeIgnitedBy (EntityAI igniter=NULL)
	Override this method so it checks whenever this item can be ignited right now or not. Evaluated on Server and Client.
bool	CanIgniteItem (EntityAI ignite_target=NULL)
	Override this method and check if the given item can be ignited right now by this one. Evaluated on Server and Client.
bool	IsIgnited ()
	Override this method and make it so it returns whenever this item is on fire right now or not. Evaluated on Server and Client.
bool	DisassembleOnLastDetach ()
bool	IsBasebuildingKit ()
bool	IsCookware ()
bool	PlacementCanBeRotated ()
	Should return false if you want to disable hologram rotation.
void	OnIgnitedTarget (EntityAI target_item)
	Executed on Server when this item ignites some target item.
void	OnIgnitedThis (EntityAI fire_source)
	Executed on Server when some item ignited this one.
void	OnIgnitedTargetFailed (EntityAI target_item)
	Executed on Server when this item failed to ignite target item.
void	OnIgnitedThisFailed (EntityAI fire_source)
	Executed on Server when some item failed to ignite this one.
bool	IsTargetIgnitionSuccessful (EntityAI item_target)
	Final evaluation just before the target item is actually ignited. Evaluated on Server.
bool	IsThisIgnitionSuccessful (EntityAI item_source=NULL)
	Final evaluation just before this item is actually ignited from fire source. Evaluated on Server.
void	OnPlacementStarted (Man player)
void	OnHologramBeingPlaced (Man player)
void	OnPlacementComplete (Man player, vector position="0 0 0", vector orientation="0 0 0")
void	OnPlacementCancelled (Man player)
bool	CanBePlaced (Man player, vector position)
string	CanBePlacedFailMessage (Man player, vector position)
	Method which returns message why object can't be placed at given position.
bool	DoPlacingHeightCheck ()
	Do the roof check when placing this?
float	HeightCheckOverride ()
	used as script-side override of distance for specific height checks
float	HeightStartCheckOverride ()
	used as script-side override of start pos for specific height checks
bool	IsEmpty ()
	is this container empty or not, checks both cargo and attachments
bool	IsSplitable ()
	returns just the configured 'canBeSplit' bool
bool	CanBeSplit ()
	returns current splitability
bool	HasAnyCargo ()
	is this container empty or not, checks only cargo
array< EntityAI >	GetAttachmentsWithCargo ()
array< EntityAI >	GetAttachmentsWithAttachments ()
bool	IsRoofAbove ()
void	SetRoofAbove (bool state)
void	CheckForRoofLimited (float timeTresholdMS=3000)
	Roof check for entity, limited by time (anti-spam solution).
int	GetAgents ()
void	RemoveAgent (int agent_id)
void	RemoveAllAgents ()
void	RemoveAllAgentsExcept (int agent_to_keep)
void	InsertAgent (int agent, float count=1)
override bool	IsEntityAI ()
bool	IsInventoryVisible ()
bool	IsPlayer ()
bool	IsAnimal ()
bool	IsZombie ()
bool	IsZombieMilitary ()
bool	IsIgnoredByConstruction ()
bool	CanBeTargetedByAI (EntityAI ai)
bool	CanBeBackstabbed ()
override void	Delete ()
	Delete this object in next frame.
void	DeleteOnClient ()
void	DeleteSafe ()
void	DeleteSave ()
bool	IsSetForDeletion ()
override bool	CanBeActionTarget ()
void	SetPrepareToDelete ()
bool	IsPreparedToDelete ()
void	CheckForDestroy ()
bool	IsPrepareToDelete ()
bool	TryDelete ()
void	OnBeforeTryDelete ()
proto native EntityAI	GetHierarchyRoot ()
	Returns root of current hierarchy (for example: if this entity is in Backpack on gnd, returns Backpack).
proto native Man	GetHierarchyRootPlayer ()
	Returns root of current hierarchy cast to Man.
proto native EntityAI	GetHierarchyParent ()
	Returns direct parent of current entity.
proto native CEItemProfile	GetEconomyProfile ()
	Get economy item profile (if assigned, otherwise null).
int	GetHierarchyLevel (int lvl=0)
void	OnInventoryInit ()
void	EEInit ()
	Called upon object creation.
void	EEDelete (EntityAI parent)
	Called right before object deleting.
override void	OnExplosionEffects (Object source, Object directHit, int componentIndex, string surface, vector pos, vector surfNormal, float energyFactor, float explosionFactor, bool isWater, string ammoType)
void	OnItemLocationChanged (EntityAI old_owner, EntityAI new_owner)
void	OnChildItemRemoved (InventoryItem item)
void	OnChildItemReceived (InventoryItem item)
void	OnItemAttachmentSlotChanged (notnull InventoryLocation oldLoc, notnull InventoryLocation newLoc)
void	EEItemLocationChanged (notnull InventoryLocation oldLoc, notnull InventoryLocation newLoc)
void	EEParentedTo (EntityAI parent)
	Called from 'IEntity.AddChild'.
void	EEParentedFrom (EntityAI parent)
	Called from 'IEntity.RemoveChild' or 'IEntity.AddChild' when hierarchy changes.
void	EEInventoryIn (Man newParentMan, EntityAI diz, EntityAI newParent)
void	EEInventoryOut (Man oldParentMan, EntityAI diz, EntityAI newParent)
void	EEAmmoChanged ()
void	EEHealthLevelChanged (int oldLevel, int newLevel, string zone)
void	OnDamageDestroyed (int oldLevel)
	Called when the health gets to the min value, 'oldLevel' is previous health level, 'oldLevel' -1 means this entity was just spawned.
void	AttemptDestructionBehaviour (int oldLevel, int newLevel, string zone)
void	SetTakeable (bool pState)
void	EEKilled (Object killer)
	called on server when the entity is killed
bool	ReplaceOnDeath ()
string	GetDeadItemName ()
bool	KeepHealthOnReplace ()
void	DeathUpdate ()
void	OnAttachmentRuined (EntityAI attachment)
	Called when some attachment of this parent is ruined. Called on server and client side.
void	EEHitBy (TotalDamageResult damageResult, int damageType, EntityAI source, int component, string dmgZone, string ammo, vector modelPos, float speedCoef)
void	EEHitByRemote (int damageType, EntityAI source, int component, string dmgZone, string ammo, vector modelPos)
void	EEItemAttached (EntityAI item, string slot_name)
void	SwitchItemSelectionTexture (EntityAI item, string slot_name)
void	SwitchItemSelectionTextureEx (EItemManipulationContext context, Param par=null)
void	EEItemDetached (EntityAI item, string slot_name)
void	EECargoIn (EntityAI item)
void	EECargoOut (EntityAI item)
void	EECargoMove (EntityAI item)
ScriptInvoker	GetOnItemAttached ()
ScriptInvoker	GetOnItemDetached ()
ScriptInvoker	GetOnItemAddedIntoCargo ()
ScriptInvoker	GetOnItemRemovedFromCargo ()
ScriptInvoker	GetOnItemMovedInCargo ()
ScriptInvoker	GetOnItemFlipped ()
ScriptInvoker	GetOnViewIndexChanged ()
ScriptInvoker	GetOnSetLock ()
ScriptInvoker	GetOnReleaseLock ()
ScriptInvoker	GetOnAttachmentSetLock ()
ScriptInvoker	GetOnAttachmentReleaseLock ()
ScriptInvoker	GetOnHitByInvoker ()
ScriptInvoker	GetOnKilledInvoker ()
void	OnMovedInsideCargo (EntityAI container)
	Called when this item enters cargo of some container.
void	OnRemovedFromCargo (EntityAI container)
	Called when this item exits cargo of some container.
void	OnMovedWithinCargo (EntityAI container)
	Called when this item moves within cargo of some container.
void	EEOnAfterLoad ()
	Called when entity is part of "connected system" and being restored after load.
void	EEOnCECreate ()
	Called when entity is being created as new by CE/ Debug.
void	AfterStoreLoad ()
	Called when entity is being loaded from DB or Storage (after all children loaded).
void	OnBinLoadItemsDropped ()
	Called when an item fails to get loaded into the inventory of an entity and gets dropped.
void	HideAllSelections ()
	Sets all animation values to 1, making them INVISIBLE if they are configured in models.cfg in such way. These selections must also be defined in the entity's config class in 'AnimationSources'.
void	ShowAllSelections ()
	Sets all animation values to 0, making them VISIBLE if they are configured in models.cfg in such way. These selections must also be defined in the entity's config class in 'AnimationSources'.
bool	CanReceiveAttachment (EntityAI attachment, int slotId)
	calls this->CanReceiveAttachment(attachment)
bool	CanLoadAttachment (EntityAI attachment)
bool	CanPutAsAttachment (EntityAI parent)
	calls this->CanPutAsAttachment(parent)
bool	CanSwitchDuringAttach (EntityAI parent)
bool	CanReleaseAttachment (EntityAI attachment)
	calls this->CanReleaseAttachment(attachment)
bool	CanDetachAttachment (EntityAI parent)
	calls this->CanDetachAttachment(parent)
bool	CanBeFSwaped ()
bool	CanCombineAttachment (notnull EntityAI e, int slot, bool stack_max_limit=false)
bool	CanBeCombined (EntityAI other_item, bool reservation_check=true, bool stack_max_limit=false)
void	CombineItemsEx (EntityAI entity2, bool use_stack_max=false)
void	SplitIntoStackMaxEx (EntityAI destination_entity, int slot_id)
void	CombineItemsClient (EntityAI entity2, bool use_stack_max=false)
void	SplitIntoStackMaxClient (EntityAI destination_entity, int slot_id)
bool	CanReceiveItemIntoCargo (EntityAI item)
	calls this->CanReceiveItemIntoCargo(item)
bool	CanLoadItemIntoCargo (EntityAI item)
	calls this->CanLoadItemIntoCargo(item), is called on server start when loading in the storage
bool	CanPutInCargo (EntityAI parent)
	calls this->CanPutInCargo(parent)
bool	CanSwapItemInCargo (EntityAI child_entity, EntityAI new_entity)
	calls this->CanSwapItemInCargo(child_entity, new_entity)
bool	CanReleaseCargo (EntityAI cargo)
	calls this->CanReleaseCargo(cargo)
bool	CanRemoveFromCargo (EntityAI parent)
	calls this->CanRemoveFromCargo(parent)
bool	CanReceiveItemIntoHands (EntityAI item_to_hands)
	calls this->CanReceiveItemIntoHands(item_to_hands)
bool	AreChildrenAccessible ()
bool	IsBeingPlaced ()
override bool	IsHologram ()
bool	CanSaveItemInHands (EntityAI item_in_hands)
bool	CanPutIntoHands (EntityAI parent)
	calls this->CanPutIntoHands(parent)
bool	CanReleaseFromHands (EntityAI handheld)
	calls this->CanReleaseFromHands(handheld)
bool	CanRemoveFromHands (EntityAI parent)
	calls this->CanRemoveFromHands(parent)
bool	CanDisplayAttachmentSlot (string slot_name)
bool	CanDisplayAttachmentSlot (int slot_id)
bool	CanDisplayAnyAttachmentSlot ()
bool	CanDisplayAttachmentCategory (string category_name)
bool	CanDisplayCargo ()
bool	CanAssignToQuickbar ()
bool	CanAssignAttachmentsToQuickbar ()
bool	IgnoreOutOfReachCondition ()
void	OnWasAttached (EntityAI parent, int slot_id)
void	OnWasDetached (EntityAI parent, int slot_id)
void	OnCargoChanged ()
bool	IsTakeable ()
proto native GameInventory	GetInventory ()
proto native void	CreateAndInitInventory ()
proto native void	DestroyInventory ()
int	GetSlotsCountCorrect ()
EntityAI	FindAttachmentBySlotName (string slot_name)
bool	IsSlotReserved (int slotID)
bool	IsLockedInSlot ()
bool	PredictiveTakeEntityToInventory (FindInventoryLocationType flags, notnull EntityAI item)
	Put item anywhere into this entity (as attachment or into cargo, recursively).
bool	LocalTakeEntityToInventory (FindInventoryLocationType flags, notnull EntityAI item)
bool	ServerTakeEntityToInventory (FindInventoryLocationType flags, notnull EntityAI item)
bool	PredictiveTakeEntityToTargetInventory (notnull EntityAI target, FindInventoryLocationType flags, notnull EntityAI item)
bool	LocalTakeEntityToTargetInventory (notnull EntityAI target, FindInventoryLocationType flags, notnull EntityAI item)
bool	ServerTakeEntityToTargetInventory (notnull EntityAI target, FindInventoryLocationType flags, notnull EntityAI item)
bool	PredictiveTakeEntityToCargo (notnull EntityAI item)
	Put item into into cargo.
bool	LocalTakeEntityToCargo (notnull EntityAI item)
bool	ServerTakeEntityToCargo (notnull EntityAI item)
bool	PredictiveTakeEntityToTargetCargo (notnull EntityAI target, notnull EntityAI item)
bool	LocalTakeEntityToTargetCargo (notnull EntityAI target, notnull EntityAI item)
bool	ServerTakeEntityToTargetCargo (notnull EntityAI target, notnull EntityAI item)
bool	PredictiveTakeEntityToCargoEx (notnull EntityAI item, int idx, int row, int col)
	Put item into into cargo on specific cargo location.
bool	LocalTakeEntityToCargoEx (notnull EntityAI item, int idx, int row, int col)
bool	PredictiveTakeEntityToTargetCargoEx (notnull CargoBase cargo, notnull EntityAI item, int row, int col)
bool	LocalTakeEntityToTargetCargoEx (notnull CargoBase cargo, notnull EntityAI item, int row, int col)
bool	ServerTakeEntityToTargetCargoEx (notnull CargoBase cargo, notnull EntityAI item, int row, int col)
bool	PredictiveTakeEntityAsAttachmentEx (notnull EntityAI item, int slot)
	Returns if item can be added as attachment on specific slot. Note that slot index IS NOT slot ID! Slot ID is defined in DZ/data/config.cpp.
bool	LocalTakeEntityAsAttachmentEx (notnull EntityAI item, int slot)
bool	ServerTakeEntityAsAttachmentEx (notnull EntityAI item, int slot)
bool	PredictiveTakeEntityToTargetAttachmentEx (notnull EntityAI target, notnull EntityAI item, int slot)
bool	LocalTakeEntityToTargetAttachmentEx (notnull EntityAI target, notnull EntityAI item, int slot)
bool	ServerTakeEntityToTargetAttachmentEx (notnull EntityAI target, notnull EntityAI item, int slot)
bool	PredictiveTakeEntityToTargetAttachment (notnull EntityAI target, notnull EntityAI item)
bool	LocalTakeEntityToTargetAttachment (notnull EntityAI target, notnull EntityAI item)
bool	ServerTakeEntityToTargetAttachment (notnull EntityAI target, notnull EntityAI item)
bool	PredictiveTakeToDst (notnull InventoryLocation src, notnull InventoryLocation dst)
bool	LocalTakeToDst (notnull InventoryLocation src, notnull InventoryLocation dst)
bool	ServerTakeToDst (notnull InventoryLocation src, notnull InventoryLocation dst)
bool	PredictiveTakeEntityAsAttachment (notnull EntityAI item)
	Put item into as attachment.
bool	LocalTakeEntityAsAttachment (notnull EntityAI item)
bool	ServerTakeEntityAsAttachment (notnull EntityAI item)
bool	PredictiveDropEntity (notnull EntityAI item)
bool	LocalDropEntity (notnull EntityAI item)
bool	ServerDropEntity (notnull EntityAI item)
EntityAI	GetAttachmentByType (typename type)
	Get attached entity by type.
EntityAI	GetAttachmentByConfigTypeName (string type)
	Get attached entity by config type name.
bool	CanDropEntity (notnull EntityAI item)
	Returns if item can be dropped out from this entity.
EntityAI	SpawnInInventoryOrGroundPos (string object_name, GameInventory inv, vector pos)
EntityAI	SpawnEntityOnGroundPos (string object_name, vector pos)
EntityAI	SpawnEntityOnGround (string object_name, vector mat[4])
bool	CanSwapEntities (EntityAI otherItem, InventoryLocation otherDestination, InventoryLocation destination)
void	SetWet (float value, bool allow_client=false)
void	AddWet (float value)
void	SetWetMax ()
float	GetWet ()
float	GetWetMax ()
float	GetWetMin ()
float	GetWetInit ()
bool	HasWetness ()
void	OnWetChanged (float newVal, float oldVal)
void	OnWetLevelChanged (EWetnessLevel newLevel, EWetnessLevel oldLevel)
EWetnessLevel	GetWetLevel ()
bool	HasQuantity ()
bool	SetQuantity (float value, bool destroy_config=true, bool destroy_forced=false, bool allow_client=false, bool clamp_to_stack_max=true)
float	GetQuantity ()
void	SetQuantityNormalized (float value, bool destroy_config=true, bool destroy_forced=false)
float	GetQuantityNormalized ()
int	GetQuantityMax ()
int	GetQuantityMin ()
void	SetQuantityToMinimum ()
int	GetTargetQuantityMax (int attSlotID=-1)
int	GetQuickBarBonus ()
bool	UseConfigInitTemperature ()
void	InitTemperature ()
void	SetTemperatureDirect (float value, bool allow_client=false)
void	SetTemperature (float value, bool allow_client=false)
	not really deprecated, but missing context info from TemperatureData. Default values used instead.
void	AddTemperature (float value)
void	SetTemperatureEx (TemperatureData data)
	sets temperature, handles base overheating and freezing state progression logics
void	RefreshTemperatureAccess (TemperatureData data)
	refreshes access without setting temperature, keeps the source locked in
void	InterpolateTempData (TemperatureDataInterpolated data)
void	SetTemperatureMax ()
	presumably for debug purposes?
float	GetTemperature ()
float	GetTemperatureInit ()
float	GetTemperatureMin ()
float	GetTemperatureMax ()
bool	GetCookingTargetTemperature (out float temperature)
	specifically for cooking system, to get heat source target temperatures
float	GetHeatPermeabilityCoef ()
	Returns temperature change speed multiplier for this item and all its children (multiplicative interaction).
float	GetTemperatureFreezeThreshold ()
float	GetTemperatureThawThreshold ()
float	GetTemperatureFreezeTime ()
float	GetTemperatureThawTime ()
float	GetFreezeThawProgress ()
	on server only
bool	IsFreezeThawProgressFinished ()
	on server only
void	SetFreezeThawProgress (float val)
	0->1 when freezing, 1->0 when thawing
bool	CanFreeze ()
bool	GetIsFrozen ()
void	SetFrozen (bool frozen)
void	HandleFreezingProgression (float deltaHeat, TemperatureData data)
void	OnFreezeStateChangeClient ()
void	OnFreezeStateChangeServer ()
bool	CanItemOverheat ()
	Overheat time CAN be 0, GameConstants.TEMPERATURE_TIME_OVERHEAT_MIN is ignored if so.
float	GetItemOverheatThreshold ()
	if undefined, max temperature used as default
float	GetItemOverheatTime ()
	any configured value >= 0 will simulate overheating
bool	IsItemOverheated ()
float	GetItemOverheatProgress ()
void	SetItemOverheatProgress (float val, float deltaTime=0)
void	OnItemOverheatStart ()
	override to implement desired overheat behavior on entity
void	OnItemOverheat (float deltaTime)
void	OnItemOverheatEnd ()
	note, that the deltaTime could be reverse-calculated and not totally accurate
void	HandleItemOverheating (float deltaHeat, TemperatureData data)
void	SetLiquidType (int value, bool allow_client=false)
int	GetLiquidType ()
void	SetColor (int r, int g, int b, int a)
void	GetColor (out int r, out int g, out int b, out int a)
void	SetStoreLoad (bool value)
bool	IsStoreLoad ()
void	SetStoreLoadedQuantity (float value)
float	GetStoreLoadedQuantity ()
void	SetCleanness (int value, bool allow_client=false)
int	GetCleanness ()
bool	IsServerCheck (bool allow_client)
HiddenSelectionsData	GetHiddenSelectionsData ()
int	GetHiddenSelectionIndex (string selection)
	Returns index of the string found in cfg array 'hiddenSelections'. If it's not found then it returns -1.
override TStringArray	GetHiddenSelections ()
	Returns the hiddenSelectionsTextures array from the object's config.
override TStringArray	GetHiddenSelectionsTextures ()
	Returns the hiddenSelectionsTextures array from the object's config.
override TStringArray	GetHiddenSelectionsMaterials ()
	Returns the hiddenSelectionsMaterials array from the object's config.
proto native void	PlaceOnSurfaceRotated (out vector trans[4], vector pos, float dx=0, float dz=0, float fAngle=0, bool align=false)
proto native void	RegisterNetSyncVariableBool (string variableName)
	registers bool variable synchronized over network
proto native void	RegisterNetSyncVariableBoolSignal (string variableName)
	when bool variable is true, it's sent to clients and become false again
proto native void	RegisterNetSyncVariableInt (string variableName, int minValue=0, int maxValue=0)
	registers int variable synchronized over network
proto native void	RegisterNetSyncVariableFloat (string variableName, float minValue=0, float maxValue=0, int precision=1)
	registers float variable synchronized over network
proto native void	RegisterNetSyncVariableObject (string variableName)
	registers object variable synchronized over network, only synchronizes if network id is assigned. Doesn't handle object despawn on client
proto native void	UpdateNetSyncVariableInt (string variableName, float minValue=0, float maxValue=0)
proto native void	UpdateNetSyncVariableFloat (string variableName, float minValue=0, float maxValue=0, int precision=1)
proto native void	SwitchLight (bool isOn)
proto native void	SetSimpleHiddenSelectionState (int index, bool state)
	Simple hidden selection state; 0 == hidden.
proto native bool	IsSimpleHiddenSelectionVisible (int index)
proto native void	SetObjectTexture (int index, string texture_name)
	Change texture in hiddenSelections.
proto native owned string	GetObjectTexture (int index)
proto native void	SetObjectMaterial (int index, string mat_name)
	Change material in hiddenSelections.
proto native owned string	GetObjectMaterial (int index)
proto native void	SetRequiredSimulation (bool req)
proto native bool	IsRequiredSimulation ()
proto native bool	IsPilotLight ()
proto native void	SetPilotLight (bool isOn)
void	OnStoreSave (ParamsWriteContext ctx)
	Engine calls this function to collect data from entity to store for persistence (on server side).
bool	OnStoreLoad (ParamsReadContext ctx, int version)
	Called when data is loaded from persistence (on server side).
proto native void	SetSynchDirty ()
	Sets object synchronization dirty flag, which signalize that object wants to be synchronized (take effect only in MP on server side).
void	OnVariablesSynchronized ()
	Called on clients after receiving synchronization data from server.
bool	IsVariableSet (int variable)
	'true' if this variable has ever been changed from default
void	SetVariableMask (int variable)
void	RemoveItemVariable (int variable)
	Removes variable from variable mask, making it appear as though the variable has never been changed from default.
void	TransferVariablesFloat (array< float > float_vars)
array< float >	GetVariablesFloat ()
void	SaveVariables (ParamsWriteContext ctx)
bool	LoadVariables (ParamsReadContext ctx, int version=-1)
void	WriteVarsToCTX (ParamsWriteContext ctx)
	Writes to storage CTX.
bool	ReadVarsFromCTX (ParamsReadContext ctx, int version=-1)
	Reads from storage CTX.
void	SerializeNumericalVars (array< float > floats_out)
void	DeSerializeNumericalVars (array< float > floats)
proto native void	SetAITargetCallbacks (AbstractAITargetCallbacks callbacks)
override void	EOnFrame (IEntity other, float timeSlice)
string	GetDebugText ()
void	GetDebugButtonNames (out string button1, out string button2, out string button3, out string button4)
void	OnDebugButtonPressClient (int button_index)
void	OnDebugButtonPressServer (int button_index)
Shape	DebugBBoxDraw ()
void	DebugBBoxSetColor (int color)
void	DebugBBoxDelete ()
Shape	DebugDirectionDraw (float distance=1)
void	DebugDirectionSetColor (int color)
void	DebugDirectionDelete ()
void	HideSelection (string selection_name)
	Hides selection of the given name. Must be configed in config.cpp and models.cfg.
void	ShowSelection (string selection_name)
	Shows selection of the given name. Must be configed in config.hpp and models.cfg.
proto void	GetPersistentID (out int b1, out int b2, out int b3, out int b4)
proto native void	SetLifetime (float fLifeTime)
	Set (override) remaining economy lifetime (seconds).
proto native float	GetLifetime ()
	Get remaining economy lifetime (seconds).
proto native void	IncreaseLifetime ()
	Reset economy lifetime to default (seconds).
proto native void	SetLifetimeMax (float fLifeTime)
	Set (override) max economy lifetime per entity instance (seconds).
proto native float	GetLifetimeMax ()
	Get max economy lifetime per instance - default is from DB (seconds).
void	IncreaseLifetimeUp ()
	Reset economy lifetime to default across entity hierarchy all the way to the topmost entity.
ComponentBodyStaging	GetCompBS ()
	Use this to access Body Staging component on dead character. Returns NULL if the given object lacks such component.
override void	OnRPC (PlayerIdentity sender, int rpc_type, ParamsReadContext ctx)
float	GetWetWeightModifier ()
float	GetConfigWeightModified ()
int	GetWeight ()
void	ClearWeightDirty ()
void	SetWeightDirty ()
float	GetInventoryAndCargoWeight (bool forceRecalc=false)
float	GetWeightSpecialized (bool forceRecalc=false)
	returns weight of the entity in a way that's specific to the entity type and is internal to the weight system calculation, to obtain entity's weight, use the 'GetWeightEx' method instead
float	GetWeightEx (bool forceRecalc=false)
	returns overall weight of the entity, 'forceRecalc = true' is meant to be used only when debugging, using it in gameplay code is higly inadvisable as it bypasses the weight caching and has adverse effect on performance
void	UpdateWeight (WeightUpdateType updateType=WeightUpdateType.FULL, float weightAdjustment=0)
float	GetSingleInventoryItemWeightEx ()
void	GetDebugActions (out TSelectableActionInfoArrayEx outputList)
bool	OnAction (int action_id, Man player, ParamsReadContext ctx)
string	GetHitComponentForAI ()
	Returns hit component for the Entity (overriden for each Type - PlayerBase, DayZInfected, DayZAnimal, etc.).
string	GetDefaultHitComponent ()
	returns default hit component for the Entity (overriden for each Type - PlayerBase, DayZInfected, DayZAnimal, etc.)
string	GetDefaultHitPositionComponent ()
	returns default hit position component name for the Entity (overriden by type if needed - used mainly as support for impact particles)
array< string >	GetSuitableFinisherHitComponents ()
vector	GetDefaultHitPosition ()
int	GetMeleeTargetType ()
	value is related to EMeleeTargetType
string	GetAttachmentSoundType ()
	returns sound type of attachment (used for clothing and weapons on DayZPlayerImplement, paired with Anim*Type enum from DayZAnimEvents)
bool	IsHeavyBehaviour ()
	returns item behaviour of item (more in ItemBase)
bool	IsOneHandedBehaviour ()
	returns item behaviour of item (more in ItemBase)
bool	IsTwoHandedBehaviour ()
	returns item behaviour of item (more in ItemBase)
string	ChangeIntoOnAttach (string slot)
string	ChangeIntoOnDetach ()
bool	CanHaveTemperature ()
	returns true used on selected items that have a temperature effect and can processes temperature changes
bool	IsSelfAdjustingTemperature ()
void	OnCEUpdate ()
	Central economy calls this function whenever going over all the entities.
void	ProcessVariables ()
void	OnDebugSpawnEx (DebugSpawnParams params)
void	OnDebugSpawn ()
override EntityAI	ProcessMeleeItemDamage (int mode=0)
float	GetLiquidThroughputCoef ()
	Returns liquid throughput coeficient.
string	GetInvulnerabilityTypeString ()
void	ProcessInvulnerabilityCheck (string servercfg_param)
void	SetBayonetAttached (bool pState, int slot_idx=-1)
bool	HasBayonetAttached ()
int	GetBayonetAttachmentIdx ()
void	SetButtstockAttached (bool pState, int slot_idx=-1)
bool	HasButtstockAttached ()
int	GetButtstockAttachmentIdx ()
void	SetInvisibleRecursive (bool invisible, EntityAI parent=null, array< int > attachments=null)
void	SoundHardTreeFallingPlay ()
void	SoundSoftTreeFallingPlay ()
void	SoundHardBushFallingPlay ()
void	SoundSoftBushFallingPlay ()
void	RegisterTransportHit (Transport transport)
bool	GetInventoryHandAnimation (notnull InventoryLocation loc, out int value)
bool	TranslateSlotFromSelection (string selection_name, out int slot_id)
bool	IsUniversalTemperatureSource ()
	Universal Temperature Sources Helpers.
UTemperatureSource	GetUniversalTemperatureSource ()
void	SetUniversalTemperatureSource (UTemperatureSource uts)
vector	GetUniversalTemperatureSourcePosition ()
RemotelyActivatedItemBehaviour	GetRemotelyActivatedItemBehaviour ()
	Remotely controlled devices helpers.
void	PairRemote (notnull EntityAI trigger)
void	UnpairRemote ()
EntityAI	GetPairDevice ()
void	SetPersistentPairID (int id)
bool	HasTurnableValveBehavior ()
	Turnable Valve behaviour.
bool	IsValveTurnable (int pValveIndex)
int	GetTurnableValveIndex (int pComponentIndex)
void	ExecuteActionsConnectedToValve (int pValveIndex)
set< int >	GetAttachmentExclusionInitSlotValue (int slotId)
	override this to modify slot behavior for specific items, or just set 'm_AttachmentExclusionMaskGlobal' value for simple items
void	InitLegacyConfigExclusionValues ()
bool	InitLegacyExclusionCheck ()
void	InitLegacySlotExclusionValuesImplicit ()
	adding base one-directional relations between headgear, masks, eyewear, and headstraps (exception)
void	InitLegacySlotExclusionValuesDerived ()
void	InitGlobalExclusionValues ()
	override to init part of the mask, independent of slot-specific behavior
void	AddSingleExclusionValueGlobal (EAttExclusions value)
	to help with item staging exclusions
void	ClearSingleExclusionValueGlobal (EAttExclusions value)
	to help with item staging exclusions
void	SetAttachmentExclusionMaskGlobal (set< int > values)
void	SetAttachmentExclusionMaskSlot (int slotId, set< int > values)
	sets values for specific slot
bool	IsExclusionFlagPresent (set< int > values)
	checks 'this' if the incoming flag is present for the current state (slot behavior and others)
bool	IsExclusionFlagPresentRecursive (set< int > values, int targetSlot)
	Gets flag from what is effectively an owner.
bool	CheckExclusionAccessCondition (int occupiedSlot, int targetSlot, set< int > value, inout set< int > adjustedValue)
void	AdjustExclusionAccessCondition (int occupiedSlot, int testedSlot, set< int > value, inout set< int > adjustedValue)
	if we want to filter
bool	CheckExclusionAccessPropagation (int occupiedSlot, int targetSlot, set< int > value, inout set< int > adjustedValue)
	special propagation contition
void	AdjustExclusionAccessPropagation (int occupiedSlot, int testedSlot, set< int > value, inout set< int > adjustedValue)
	if we want to filter propagation specifically; DO NOT override unless you know what you are doing.
bool	CheckAttachmentReceiveExclusion (EntityAI attachment, int slotId)
	checks specifically for att. exclusion conflicts before att. receive
bool	IsManagingArrows ()
ArrowManagerBase	GetArrowManager ()
void	SetFromProjectile (ProjectileStoppedInfo info)
void	ClearInventory ()
bool	IsSkinned ()
	Skinning.
void	SetAsSkinned ()
bool	CanBeSkinnedWith (EntityAI tool)
float	GetSkinningBloodInfectionChance (eAgents type)
void	CacheSkinningBloodInfectionChance (eAgents type)
ComponentEnergyManager	GetCompEM ()
bool	HasEnergyManager ()
	If this item has class EnergyManager in its config then it returns true. Otherwise returns false.
void	OnWorkStart ()
	Energy manager event: Called only once when this device starts doing its work.
void	OnWork (float consumed_energy)
	Energy manager event: Called every device update if its supposed to do some work. The update can be every second or at random, depending on its manipulation.
void	OnWorkStop ()
	Energy manager event: Called when the device stops working (was switched OFF or ran out of energy).
void	OnSwitchOn ()
	Energy manager event: Called when the device is switched on.
void	OnSwitchOff ()
	Energy manager event: Called when the device is switched OFF.
void	OnIsPlugged (EntityAI source_device)
	Energy manager event: Called when this device is plugged into some energy source.
void	OnIsUnplugged (EntityAI last_energy_source)
	Energy manager event: Called when this device is UNPLUGGED from the energy source.
void	OnOwnSocketTaken (EntityAI device)
	Energy manager event: When something is plugged into this device.
void	OnOwnSocketReleased (EntityAI device)
	Energy manager event: When something is UNPLUGGED from this device.
void	OnInitEnergy ()
	Energy manager event: Object's initialization. Energy Manager is fully initialized by this point.
void	OnEnergyConsumed ()
	Energy manager event: Called when energy was consumed on this device. ALWAYS CALL super.OnEnergyConsumed() !!!
void	OnEnergyAdded ()
	Energy manager event: Called when energy was added on this device. ALWAYS CALL super.OnEnergyAdded() !!!

Static Protected Member Functions
static EWetnessLevel	GetWetLevelInternal (float wetness)

Protected Attributes
bool	m_RoofAbove = false
ref DamageZoneMap	m_DamageZoneMap
bool	m_CanDisplayWeight
float	m_ElapsedSinceLastUpdate
float	m_PreviousRoofTestTime = 0
UTemperatureSource	m_UniversalTemperatureSource
bool	m_PendingDelete = false
bool	m_Initialized = false
bool	m_TransportHitRegistered = false
vector	m_TransportHitVelocity
int	m_VariablesMask
float	m_VarTemperature
float	m_VarTemperatureInit
float	m_VarTemperatureMin
float	m_VarTemperatureMax
float	m_VarTemperatureFreezeThreshold
float	m_VarTemperatureThawThreshold
float	m_VarTemperatureFreezeTime
float	m_VarTemperatureThawTime
float	m_VarTemperatureOverheatTime
float	m_VarHeatPermeabilityCoef
ref TemperatureAccessComponent	m_TAC
bool	m_IsFrozen
bool	m_IsFrozenLocal
float	m_FreezeThawProgress
float	m_OverheatProgress
ref ScriptInvoker	m_OnItemAttached
ref ScriptInvoker	m_OnItemDetached
ref ScriptInvoker	m_OnItemAddedIntoCargo
ref ScriptInvoker	m_OnItemRemovedFromCargo
ref ScriptInvoker	m_OnItemMovedInCargo
ref ScriptInvoker	m_OnItemFlipped
ref ScriptInvoker	m_OnViewIndexChanged
ref ScriptInvoker	m_OnSetLock
ref ScriptInvoker	m_OnReleaseLock
ref ScriptInvoker	m_OnAttachmentSetLock
ref ScriptInvoker	m_OnAttachmentReleaseLock
ref ScriptInvoker	m_OnHitByInvoker
ref ScriptInvoker	m_OnKilledInvoker
int	m_ViewIndex = 0
void	SetViewIndex (int index)
	Sets item preview index.
int	GetViewIndex ()
	Returns item preview index !!!! IF OVERRIDING with more dynamic events call GetOnViewIndexChanged() in constructor on client !!!!

Detailed Description

Definition at line 1 of file camera.c.

Member Function Documentation

AddSingleExclusionValueGlobal()

void Entity::AddSingleExclusionValueGlobal ( EAttExclusions value )

protected

to help with item staging exclusions

Definition at line 4440 of file entityai.c.

AddTemperature()

void Entity::AddTemperature ( float value )

protected

Definition at line 2335 of file entityai.c.

AddWet()

void Entity::AddWet ( float value )

protected

AdjustExclusionAccessCondition()

void Entity::AdjustExclusionAccessCondition ( int occupiedSlot, int testedSlot, set< int > value, inout set< int > adjustedValue )

protected

if we want to filter

Definition at line 4627 of file entityai.c.

AdjustExclusionAccessPropagation()

void Entity::AdjustExclusionAccessPropagation ( int occupiedSlot, int testedSlot, set< int > value, inout set< int > adjustedValue )

protected

if we want to filter propagation specifically; DO NOT override unless you know what you are doing.

Definition at line 4649 of file entityai.c.

AfterStoreLoad()

void Entity::AfterStoreLoad ( )

protected

Called when entity is being loaded from DB or Storage (after all children loaded).

Definition at line 1391 of file entityai.c.

AreChildrenAccessible()

bool Entity::AreChildrenAccessible ( )

protected

Definition at line 1657 of file entityai.c.

AttemptDestructionBehaviour()

void Entity::AttemptDestructionBehaviour ( int oldLevel, int newLevel, string zone )

protected

Definition at line 1049 of file entityai.c.

CacheSkinningBloodInfectionChance()

void Entity::CacheSkinningBloodInfectionChance ( eAgents type )

protected

Definition at line 525 of file entityai.c.

CanAssignAttachmentsToQuickbar()

bool Entity::CanAssignAttachmentsToQuickbar ( )

protected

Returns

true if attached item can be assigned to quickbar safely

Definition at line 1800 of file entityai.c.

CanAssignToQuickbar()

bool Entity::CanAssignToQuickbar ( )

protected

Returns

true if item can be assigned to quickbar safely

Definition at line 1792 of file entityai.c.

CanBeActionTarget()

override bool Entity::CanBeActionTarget ( )

protected

Definition at line 812 of file entityai.c.

CanBeBackstabbed()

bool Entity::CanBeBackstabbed ( )

protected

Definition at line 761 of file entityai.c.

CanBeCombined()

bool Entity::CanBeCombined ( EntityAI other_item, bool reservation_check = true, bool stack_max_limit = false )

protected

Definition at line 1530 of file entityai.c.

CanBeFSwaped()

bool Entity::CanBeFSwaped ( )

protected

Definition at line 1517 of file entityai.c.

CanBeIgnitedBy()

bool Entity::CanBeIgnitedBy ( EntityAI igniter = NULL )

protected

Override this method so it checks whenever this item can be ignited right now or not. Evaluated on Server and Client.

Definition at line 546 of file entityai.c.

CanBePlaced()

bool Entity::CanBePlaced ( Man player, vector position )

protected

Definition at line 630 of file entityai.c.

CanBePlacedFailMessage()

string Entity::CanBePlacedFailMessage ( Man player, vector position )

protected

Method which returns message why object can't be placed at given position.

Definition at line 636 of file entityai.c.

CanBeSkinnedWith()

bool Entity::CanBeSkinnedWith ( EntityAI tool )

protected

Definition at line 508 of file entityai.c.

CanBeSplit()

bool Entity::CanBeSplit ( )

protected

returns current splitability

Definition at line 672 of file entityai.c.

CanBeTargetedByAI()

bool Entity::CanBeTargetedByAI ( EntityAI ai )

protected

Definition at line 749 of file entityai.c.

CanCombineAttachment()

bool Entity::CanCombineAttachment ( notnull EntityAI e, int slot, bool stack_max_limit = false )

protected

Definition at line 1522 of file entityai.c.

CanDetachAttachment()

bool Entity::CanDetachAttachment ( EntityAI parent )

protected

calls this->CanDetachAttachment(parent)

Returns

true if action allowed

Note

: return scriptConditionExecute(this, parent, "CanDetachAttachment");

Definition at line 1512 of file entityai.c.

CanDisplayAnyAttachmentSlot()

bool Entity::CanDisplayAnyAttachmentSlot ( )

protected

Returns

true if any attachment slot can be shown

Definition at line 1755 of file entityai.c.

CanDisplayAttachmentCategory()

bool Entity::CanDisplayAttachmentCategory ( string category_name )

protected

Parameters

category_name->name

of the attachment category that will or won't be displayed

Returns

true if attachment icon can be displayed in UI (inventory)

Definition at line 1776 of file entityai.c.

CanDisplayAttachmentSlot() [1/2]

bool Entity::CanDisplayAttachmentSlot ( int slot_id )

protected

Definition at line 1747 of file entityai.c.

CanDisplayAttachmentSlot() [2/2]

bool Entity::CanDisplayAttachmentSlot ( string slot_name )

protected

Definition at line 1737 of file entityai.c.

CanDisplayCargo()

bool Entity::CanDisplayCargo ( )

protected

Returns

true if cargo can be displayed in UI (inventory)

Definition at line 1784 of file entityai.c.

CanDisplayWeight()

bool Entity::CanDisplayWeight ( )

protected

'displayWeight' in item config

Definition at line 473 of file entityai.c.

CanDropEntity()

bool Entity::CanDropEntity ( notnull EntityAI item )

protected

Returns if item can be dropped out from this entity.

Definition at line 2132 of file entityai.c.

CanFreeze()

bool Entity::CanFreeze ( )

protected

Definition at line 2530 of file entityai.c.

CanHaveTemperature()

bool Entity::CanHaveTemperature ( )

protected

returns true used on selected items that have a temperature effect and can processes temperature changes

Definition at line 3844 of file entityai.c.

CanIgniteItem()

bool Entity::CanIgniteItem ( EntityAI ignite_target = NULL )

protected

Override this method and check if the given item can be ignited right now by this one. Evaluated on Server and Client.

Definition at line 552 of file entityai.c.

CanItemOverheat()

bool Entity::CanItemOverheat ( )

protected

Overheat time CAN be 0, GameConstants.TEMPERATURE_TIME_OVERHEAT_MIN is ignored if so.

Definition at line 2648 of file entityai.c.

CanLoadAttachment()

bool Entity::CanLoadAttachment ( EntityAI attachment )

protected

Definition at line 1456 of file entityai.c.

CanLoadItemIntoCargo()

bool Entity::CanLoadItemIntoCargo ( EntityAI item )

protected

calls this->CanLoadItemIntoCargo(item), is called on server start when loading in the storage

Returns

true if action allowed

Note

: return scriptConditionExecute(this, item, "CanLoadItemIntoCargo");

Definition at line 1568 of file entityai.c.

CanPutAsAttachment()

bool Entity::CanPutAsAttachment ( EntityAI parent )

protected

calls this->CanPutAsAttachment(parent)

Parameters

[in]

parent

target entity this is trying to attach to

Returns

true if action allowed

Note

: engine code is scriptConditionExecute(this, parent, "CanPutAsAttachment")

Definition at line 1468 of file entityai.c.

CanPutInCargo()

bool Entity::CanPutInCargo ( EntityAI parent )

protected

calls this->CanPutInCargo(parent)

Returns

true if action allowed

Note

: return scriptConditionExecute(this, parent, "CanPutInCargo");

Definition at line 1579 of file entityai.c.

CanPutIntoHands()

bool Entity::CanPutIntoHands ( EntityAI parent )

protected

calls this->CanPutIntoHands(parent)

Returns

true if action allowed

Note

: return scriptConditionExecute(this, parent, "CanPutIntoHands");

Definition at line 1706 of file entityai.c.

CanReceiveAttachment()

bool Entity::CanReceiveAttachment ( EntityAI attachment, int slotId )

protected

calls this->CanReceiveAttachment(attachment)

Returns

true if action allowed

Note

: return scriptConditionExecute(this, attachment, "CanReceiveAttachment");

Definition at line 1444 of file entityai.c.

CanReceiveItemIntoCargo()

bool Entity::CanReceiveItemIntoCargo ( EntityAI item )

protected

calls this->CanReceiveItemIntoCargo(item)

Returns

true if action allowed

Note

: return scriptConditionExecute(this, item, "CanReceiveItemIntoCargo");

Definition at line 1550 of file entityai.c.

CanReceiveItemIntoHands()

bool Entity::CanReceiveItemIntoHands ( EntityAI item_to_hands )

protected

calls this->CanReceiveItemIntoHands(item_to_hands)

Returns

true if action allowed

Note

: scriptConditionExecute(this, item_to_hands, "CanReceiveItemIntoHands");

Definition at line 1652 of file entityai.c.

CanReleaseAttachment()

bool Entity::CanReleaseAttachment ( EntityAI attachment )

protected

calls this->CanReleaseAttachment(attachment)

Returns

true if action allowed

Note

: return scriptConditionExecute(this, attachment, "CanReleaseAttachment");

Definition at line 1484 of file entityai.c.

CanReleaseCargo()

bool Entity::CanReleaseCargo ( EntityAI cargo )

protected

calls this->CanReleaseCargo(cargo)

Returns

true if action allowed

Note

: return scriptConditionExecute(this, cargo, "CanReleaseCargo");

Definition at line 1608 of file entityai.c.

CanReleaseFromHands()

bool Entity::CanReleaseFromHands ( EntityAI handheld )

protected

calls this->CanReleaseFromHands(handheld)

Returns

true if action allowed

Note

: scriptConditionExecute(this, handheld, "CanReleaseFromHands");

Definition at line 1717 of file entityai.c.

CanRemoveFromCargo()

bool Entity::CanRemoveFromCargo ( EntityAI parent )

protected

calls this->CanRemoveFromCargo(parent)

Returns

true if action allowed

Note

: return scriptConditionExecute(this, parent, "CanRemoveFromCargo");

Definition at line 1619 of file entityai.c.

CanRemoveFromHands()

bool Entity::CanRemoveFromHands ( EntityAI parent )

protected

calls this->CanRemoveFromHands(parent)

Returns

true if action allowed

Note

: return scriptConditionExecute(this, parent, "CanRemoveFromHands");

Definition at line 1728 of file entityai.c.

CanSaveItemInHands()

bool Entity::CanSaveItemInHands ( EntityAI item_in_hands )

protected

Definition at line 1695 of file entityai.c.

CanSwapEntities()

bool Entity::CanSwapEntities ( EntityAI otherItem, InventoryLocation otherDestination, InventoryLocation destination )

protected

Definition at line 2173 of file entityai.c.

CanSwapItemInCargo()

bool Entity::CanSwapItemInCargo ( EntityAI child_entity, EntityAI new_entity )

protected

calls this->CanSwapItemInCargo(child_entity, new_entity)

Returns

true if action allowed

Note

: return ScriptConditionExecute(GetOwner(), child_entity, "CanSwapItemInCargo", new_entity);

Definition at line 1590 of file entityai.c.

CanSwitchDuringAttach()

bool Entity::CanSwitchDuringAttach ( EntityAI parent )

protected

Definition at line 1474 of file entityai.c.

ChangeIntoOnAttach()

string Entity::ChangeIntoOnAttach ( string slot )

protected

Definition at line 3840 of file entityai.c.

ChangeIntoOnDetach()

string Entity::ChangeIntoOnDetach ( )

protected

Definition at line 3841 of file entityai.c.

CheckAttachmentReceiveExclusion()

bool Entity::CheckAttachmentReceiveExclusion ( EntityAI attachment, int slotId )

protected

checks specifically for att. exclusion conflicts before att. receive

Definition at line 4655 of file entityai.c.

CheckExclusionAccessCondition()

bool Entity::CheckExclusionAccessCondition ( int occupiedSlot, int targetSlot, set< int > value, inout set< int > adjustedValue )

protected

Definition at line 4605 of file entityai.c.

CheckExclusionAccessPropagation()

bool Entity::CheckExclusionAccessPropagation ( int occupiedSlot, int targetSlot, set< int > value, inout set< int > adjustedValue )

protected

special propagation contition

Definition at line 4633 of file entityai.c.

CheckForDestroy()

void Entity::CheckForDestroy ( )

protected

Definition at line 835 of file entityai.c.

CheckForRoofLimited()

void Entity::CheckForRoofLimited ( float timeTresholdMS = 3000 )

protected

Roof check for entity, limited by time (anti-spam solution).

ClearInventory()

void Entity::ClearInventory ( )

protected

ClearSingleExclusionValueGlobal()

void Entity::ClearSingleExclusionValueGlobal ( EAttExclusions value )

protected

to help with item staging exclusions

Definition at line 4447 of file entityai.c.

ClearWeightDirty()

void Entity::ClearWeightDirty ( )

protected

Definition at line 3553 of file entityai.c.

CombineItemsClient()

void Entity::CombineItemsClient ( EntityAI entity2, bool use_stack_max = false )

protected

Definition at line 1539 of file entityai.c.

CombineItemsEx()

void Entity::CombineItemsEx ( EntityAI entity2, bool use_stack_max = false )

protected

ConvertNonlethalDamage() [1/2]

float Entity::ConvertNonlethalDamage ( float damage )

protected

DEPRECATED - for legacy purposes.

Definition at line 457 of file entityai.c.

ConvertNonlethalDamage() [2/2]

float Entity::ConvertNonlethalDamage ( float damage, DamageType damageType )

protected

Definition at line 451 of file entityai.c.

CreateAndInitInventory()

proto native void Entity::CreateAndInitInventory ( )

protected

DeathUpdate()

void Entity::DeathUpdate ( )

protected

Definition at line 1104 of file entityai.c.

DebugBBoxDelete()

void Entity::DebugBBoxDelete ( )

protected

Definition at line 3335 of file entityai.c.

DebugBBoxDraw()

Shape Entity::DebugBBoxDraw ( )

protected

Definition at line 3325 of file entityai.c.

DebugBBoxSetColor()

void Entity::DebugBBoxSetColor ( int color )

protected

Definition at line 3330 of file entityai.c.

DebugDirectionDelete()

void Entity::DebugDirectionDelete ( )

protected

Definition at line 3350 of file entityai.c.

DebugDirectionDraw()

Shape Entity::DebugDirectionDraw ( float distance = 1 )

protected

Definition at line 3340 of file entityai.c.

DebugDirectionSetColor()

void Entity::DebugDirectionSetColor ( int color )

protected

Definition at line 3345 of file entityai.c.

Delete()

override void Entity::Delete ( )

protected

Delete this object in next frame.

Returns

void

ItemBase item = g_Game.GetPlayer().CreateInInventory("GrenadeRGD5");
item.Delete();

Definition at line 774 of file entityai.c.

DeleteOnClient()

void Entity::DeleteOnClient ( )

protected

Definition at line 780 of file entityai.c.

DeleteSafe()

void Entity::DeleteSafe ( )

protected

Definition at line 786 of file entityai.c.

DeleteSave()

void Entity::DeleteSave ( )

protected

Definition at line 802 of file entityai.c.

DeSerializeNumericalVars()

void Entity::DeSerializeNumericalVars ( array< float > floats )

protected

Definition at line 3254 of file entityai.c.

DestroyInventory()

proto native void Entity::DestroyInventory ( )

protected

DisassembleOnLastDetach()

bool Entity::DisassembleOnLastDetach ( )

protected

Definition at line 566 of file entityai.c.

DoPlacingHeightCheck()

bool Entity::DoPlacingHeightCheck ( )

protected

Do the roof check when placing this?

Definition at line 642 of file entityai.c.

EEAmmoChanged()

void Entity::EEAmmoChanged ( )

protected

Definition at line 1022 of file entityai.c.

EECargoIn()

void Entity::EECargoIn ( EntityAI item )

protected

Definition at line 1208 of file entityai.c.

EECargoMove()

void Entity::EECargoMove ( EntityAI item )

protected

Definition at line 1234 of file entityai.c.

EECargoOut()

void Entity::EECargoOut ( EntityAI item )

protected

Definition at line 1221 of file entityai.c.

EEDelete()

void Entity::EEDelete ( EntityAI parent )

protected

Called right before object deleting.

Definition at line 934 of file entityai.c.

EEHealthLevelChanged()

void Entity::EEHealthLevelChanged ( int oldLevel, int newLevel, string zone )

protected

Definition at line 1027 of file entityai.c.

EEHitBy()

void Entity::EEHitBy ( TotalDamageResult damageResult, int damageType, EntityAI source, int component, string dmgZone, string ammo, vector modelPos, float speedCoef )

protected

Definition at line 1117 of file entityai.c.

EEHitByRemote()

void Entity::EEHitByRemote ( int damageType, EntityAI source, int component, string dmgZone, string ammo, vector modelPos )

protected

Definition at line 1127 of file entityai.c.

EEInit()

void Entity::EEInit ( )

protected

Called upon object creation.

Definition at line 900 of file entityai.c.

EEInventoryIn()

void Entity::EEInventoryIn ( Man newParentMan, EntityAI diz, EntityAI newParent )

protected

EEInventoryOut()

void Entity::EEInventoryOut ( Man oldParentMan, EntityAI diz, EntityAI newParent )

protected

Definition at line 1010 of file entityai.c.

EEItemAttached()

void Entity::EEItemAttached ( EntityAI item, string slot_name )

protected

Definition at line 1133 of file entityai.c.

EEItemDetached()

void Entity::EEItemDetached ( EntityAI item, string slot_name )

protected

Definition at line 1173 of file entityai.c.

EEItemLocationChanged()

void Entity::EEItemLocationChanged ( notnull InventoryLocation oldLoc, notnull InventoryLocation newLoc )

protected

Definition at line 962 of file entityai.c.

EEKilled()

void Entity::EEKilled ( Object killer )

protected

called on server when the entity is killed

Definition at line 1078 of file entityai.c.

EEOnAfterLoad()

void Entity::EEOnAfterLoad ( )

protected

Called when entity is part of "connected system" and being restored after load.

Definition at line 1353 of file entityai.c.

EEOnCECreate()

void Entity::EEOnCECreate ( )

protected

Called when entity is being created as new by CE/ Debug.

Definition at line 1386 of file entityai.c.

EEParentedFrom()

void Entity::EEParentedFrom ( EntityAI parent )

protected

Called from 'IEntity.RemoveChild' or 'IEntity.AddChild' when hierarchy changes.

EEParentedTo()

void Entity::EEParentedTo ( EntityAI parent )

protected

Called from 'IEntity.AddChild'.

EOnFrame()

override void Entity::EOnFrame ( IEntity other, float timeSlice )

protected

Definition at line 3282 of file entityai.c.

ExecuteActionsConnectedToValve()

void Entity::ExecuteActionsConnectedToValve ( int pValveIndex )

protected

FindAttachmentBySlotName()

EntityAI Entity::FindAttachmentBySlotName ( string slot_name )

protected

Definition at line 1847 of file entityai.c.

GetAgents()

int Entity::GetAgents ( )

protected

Definition at line 711 of file entityai.c.

GetArrowManager()

ArrowManagerBase Entity::GetArrowManager ( )

protected

Definition at line 4699 of file entityai.c.

GetAttachmentByConfigTypeName()

EntityAI Entity::GetAttachmentByConfigTypeName ( string type )

protected

Get attached entity by config type name.

Definition at line 2117 of file entityai.c.

GetAttachmentByType()

EntityAI Entity::GetAttachmentByType ( typename type )

protected

Get attached entity by type.

Definition at line 2101 of file entityai.c.

GetAttachmentExclusionInitSlotValue()

set< int > Entity::GetAttachmentExclusionInitSlotValue ( int slotId )

protected

override this to modify slot behavior for specific items, or just set 'm_AttachmentExclusionMaskGlobal' value for simple items

Definition at line 4251 of file entityai.c.

GetAttachmentSoundType()

string Entity::GetAttachmentSoundType ( )

protected

returns sound type of attachment (used for clothing and weapons on DayZPlayerImplement, paired with Anim*Type enum from DayZAnimEvents)

Definition at line 3817 of file entityai.c.

GetAttachmentsWithAttachments()

array< EntityAI > Entity::GetAttachmentsWithAttachments ( )

protected

Definition at line 692 of file entityai.c.

GetAttachmentsWithCargo()

array< EntityAI > Entity::GetAttachmentsWithCargo ( )

protected

Definition at line 687 of file entityai.c.

GetBayonetAttachmentIdx()

int Entity::GetBayonetAttachmentIdx ( )

protected

Definition at line 4006 of file entityai.c.

GetButtstockAttachmentIdx()

int Entity::GetButtstockAttachmentIdx ( )

protected

Definition at line 4010 of file entityai.c.

GetCleanness()

int Entity::GetCleanness ( )

protected

Definition at line 2761 of file entityai.c.

GetColor()

void Entity::GetColor ( out int r, out int g, out int b, out int a )

protected

Definition at line 2736 of file entityai.c.

GetCompBS()

ComponentBodyStaging Entity::GetCompBS ( )

protected

Use this to access Body Staging component on dead character. Returns NULL if the given object lacks such component.

Definition at line 3400 of file entityai.c.

GetCompEM()

ComponentEnergyManager Entity::GetCompEM ( )

protected

energy manager ENERGY MANAGER:Documentation: Confluence >> Camping & Squatting >> Electricity >> Energy Manager functionalities Use this to access Energy Manager component on your device. Returns NULL if the given object lacks such component.

Definition at line 3410 of file entityai.c.

GetConfigWeightModified()

float Entity::GetConfigWeightModified ( )

protected

Definition at line 3530 of file entityai.c.

GetCookingTargetTemperature()

bool Entity::GetCookingTargetTemperature ( out float temperature )

protected

specifically for cooking system, to get heat source target temperatures

Definition at line 2478 of file entityai.c.

GetDeadItemName()

string Entity::GetDeadItemName ( )

protected

Definition at line 1094 of file entityai.c.

GetDebugActions()

void Entity::GetDebugActions ( out TSelectableActionInfoArrayEx outputList )

protected

Definition at line 3643 of file entityai.c.

GetDebugButtonNames()

void Entity::GetDebugButtonNames ( out string button1, out string button2, out string button3, out string button4 )

protected

Definition at line 3320 of file entityai.c.

GetDebugText()

string Entity::GetDebugText ( )

protected

Definition at line 3296 of file entityai.c.

GetDefaultHitComponent()

string Entity::GetDefaultHitComponent ( )

protected

returns default hit component for the Entity (overriden for each Type - PlayerBase, DayZInfected, DayZAnimal, etc.)

returns Global so it is obvious you need to configure that properly on entity

Definition at line 3784 of file entityai.c.

GetDefaultHitPosition()

vector Entity::GetDefaultHitPosition ( )

protected

Definition at line 3804 of file entityai.c.

GetDefaultHitPositionComponent()

string Entity::GetDefaultHitPositionComponent ( )

protected

returns default hit position component name for the Entity (overriden by type if needed - used mainly as support for impact particles)

Definition at line 3792 of file entityai.c.

GetEconomyProfile()

proto native CEItemProfile Entity::GetEconomyProfile ( )

protected

Get economy item profile (if assigned, otherwise null).

GetEntityDamageDisplayNameMap()

map< int, string > Entity::GetEntityDamageDisplayNameMap ( )

protected

Definition at line 467 of file entityai.c.

GetEntityDamageZoneMap()

DamageZoneMap Entity::GetEntityDamageZoneMap ( )

protected

Definition at line 462 of file entityai.c.

GetFreezeThawProgress()

float Entity::GetFreezeThawProgress ( )

protected

on server only

Definition at line 2513 of file entityai.c.

GetHeatPermeabilityCoef()

float Entity::GetHeatPermeabilityCoef ( )

protected

Returns temperature change speed multiplier for this item and all its children (multiplicative interaction).

Note

Values > 1 accelerate, values in <0,1) interval decelerate. Values < 0 should not be used here, but I'm not your mom.

Definition at line 2487 of file entityai.c.

GetHiddenSelectionIndex()

int Entity::GetHiddenSelectionIndex ( string selection )

protected

Returns index of the string found in cfg array 'hiddenSelections'. If it's not found then it returns -1.

Definition at line 2793 of file entityai.c.

GetHiddenSelections()

override TStringArray Entity::GetHiddenSelections ( )

protected

Returns the hiddenSelectionsTextures array from the object's config.

Definition at line 2802 of file entityai.c.

GetHiddenSelectionsData()

HiddenSelectionsData Entity::GetHiddenSelectionsData ( )

protected

Definition at line 2787 of file entityai.c.

GetHiddenSelectionsMaterials()

override TStringArray Entity::GetHiddenSelectionsMaterials ( )

protected

Returns the hiddenSelectionsMaterials array from the object's config.

Definition at line 2820 of file entityai.c.

GetHiddenSelectionsTextures()

override TStringArray Entity::GetHiddenSelectionsTextures ( )

protected

Returns the hiddenSelectionsTextures array from the object's config.

Definition at line 2811 of file entityai.c.

GetHierarchyLevel()

int Entity::GetHierarchyLevel ( int lvl = 0 )

protected

Definition at line 886 of file entityai.c.

GetHierarchyParent()

proto native EntityAI Entity::GetHierarchyParent ( )

protected

Returns direct parent of current entity.

GetHierarchyRoot()

proto native EntityAI Entity::GetHierarchyRoot ( )

protected

Returns root of current hierarchy (for example: if this entity is in Backpack on gnd, returns Backpack).

GetHierarchyRootPlayer()

proto native Man Entity::GetHierarchyRootPlayer ( )

protected

Returns root of current hierarchy cast to Man.

GetHitComponentForAI()

string Entity::GetHitComponentForAI ( )

protected

Returns hit component for the Entity (overriden for each Type - PlayerBase, DayZInfected, DayZAnimal, etc.).

returns Global so it is obvious you need to configure that properly on entity

Definition at line 3776 of file entityai.c.

GetInventory()

proto native GameInventory Entity::GetInventory ( )

protected

GetInventoryAndCargoWeight()

float Entity::GetInventoryAndCargoWeight ( bool forceRecalc = false )

protected

Definition at line 3580 of file entityai.c.

GetInventoryHandAnimation()

bool Entity::GetInventoryHandAnimation ( notnull InventoryLocation loc, out int value )

protected

Definition at line 4159 of file entityai.c.

GetInvulnerabilityTypeString()

string Entity::GetInvulnerabilityTypeString ( )

protected

Definition at line 3976 of file entityai.c.

GetIsFrozen()

bool Entity::GetIsFrozen ( )

protected

Definition at line 2535 of file entityai.c.

GetItemOverheatProgress()

float Entity::GetItemOverheatProgress ( )

protected

Definition at line 2670 of file entityai.c.

GetItemOverheatThreshold()

float Entity::GetItemOverheatThreshold ( )

protected

if undefined, max temperature used as default

Definition at line 2654 of file entityai.c.

GetItemOverheatTime()

float Entity::GetItemOverheatTime ( )

protected

any configured value >= 0 will simulate overheating

Definition at line 2660 of file entityai.c.

GetLifetime()

proto native float Entity::GetLifetime ( )

protected

Get remaining economy lifetime (seconds).

GetLifetimeMax()

proto native float Entity::GetLifetimeMax ( )

protected

Get max economy lifetime per instance - default is from DB (seconds).

GetLiquidThroughputCoef()

float Entity::GetLiquidThroughputCoef ( )

protected

Returns liquid throughput coeficient.

Definition at line 3971 of file entityai.c.

GetLiquidType()

int Entity::GetLiquidType ( )

protected

Definition at line 2729 of file entityai.c.

GetMeleeTargetType()

int Entity::GetMeleeTargetType ( )

protected

value is related to EMeleeTargetType

Definition at line 3811 of file entityai.c.

GetObjectMaterial()

proto native owned string Entity::GetObjectMaterial ( int index )

protected

GetObjectTexture()

proto native owned string Entity::GetObjectTexture ( int index )

protected

GetOnAttachmentReleaseLock()

ScriptInvoker Entity::GetOnAttachmentReleaseLock ( )

protected

Definition at line 1311 of file entityai.c.

GetOnAttachmentSetLock()

ScriptInvoker Entity::GetOnAttachmentSetLock ( )

protected

Definition at line 1304 of file entityai.c.

GetOnHitByInvoker()

ScriptInvoker Entity::GetOnHitByInvoker ( )

protected

Definition at line 1318 of file entityai.c.

GetOnItemAddedIntoCargo()

ScriptInvoker Entity::GetOnItemAddedIntoCargo ( )

protected

Definition at line 1255 of file entityai.c.

GetOnItemAttached()

ScriptInvoker Entity::GetOnItemAttached ( )

protected

Definition at line 1241 of file entityai.c.

GetOnItemDetached()

ScriptInvoker Entity::GetOnItemDetached ( )

protected

Definition at line 1248 of file entityai.c.

GetOnItemFlipped()

ScriptInvoker Entity::GetOnItemFlipped ( )

protected

Definition at line 1276 of file entityai.c.

GetOnItemMovedInCargo()

ScriptInvoker Entity::GetOnItemMovedInCargo ( )

protected

Definition at line 1269 of file entityai.c.

GetOnItemRemovedFromCargo()

ScriptInvoker Entity::GetOnItemRemovedFromCargo ( )

protected

Definition at line 1262 of file entityai.c.

GetOnKilledInvoker()

ScriptInvoker Entity::GetOnKilledInvoker ( )

protected

Definition at line 1325 of file entityai.c.

GetOnReleaseLock()

ScriptInvoker Entity::GetOnReleaseLock ( )

protected

Definition at line 1297 of file entityai.c.

GetOnSetLock()

ScriptInvoker Entity::GetOnSetLock ( )

protected

Definition at line 1290 of file entityai.c.

GetOnViewIndexChanged()

ScriptInvoker Entity::GetOnViewIndexChanged ( )

protected

Definition at line 1283 of file entityai.c.

GetPairDevice()

EntityAI Entity::GetPairDevice ( )

protected

GetPersistentID()

proto void Entity::GetPersistentID ( out int b1, out int b2, out int b3, out int b4 )

protected

Returns blocks of bits of persistence id of this entity. This id stays the same even after server restart.

GetQuantity()

float Entity::GetQuantity ( )

protected

Definition at line 2244 of file entityai.c.

GetQuantityMax()

int Entity::GetQuantityMax ( )

protected

Definition at line 2256 of file entityai.c.

GetQuantityMin()

int Entity::GetQuantityMin ( )

protected

Definition at line 2261 of file entityai.c.

GetQuantityNormalized()

float Entity::GetQuantityNormalized ( )

protected

Definition at line 2251 of file entityai.c.

GetQuickBarBonus()

int Entity::GetQuickBarBonus ( )

protected

Definition at line 2273 of file entityai.c.

GetRemotelyActivatedItemBehaviour()

RemotelyActivatedItemBehaviour Entity::GetRemotelyActivatedItemBehaviour ( )

protected

Remotely controlled devices helpers.

GetSingleInventoryItemWeightEx()

float Entity::GetSingleInventoryItemWeightEx ( )

protected

Definition at line 3641 of file entityai.c.

GetSkinningBloodInfectionChance()

float Entity::GetSkinningBloodInfectionChance ( eAgents type )

protected

Definition at line 516 of file entityai.c.

GetSlotsCountCorrect()

int Entity::GetSlotsCountCorrect ( )

protected

Definition at line 1838 of file entityai.c.

GetStoreLoadedQuantity()

float Entity::GetStoreLoadedQuantity ( )

protected

Definition at line 2753 of file entityai.c.

GetSuitableFinisherHitComponents()

array< string > Entity::GetSuitableFinisherHitComponents ( )

protected

Definition at line 3798 of file entityai.c.

GetTargetQuantityMax()

int Entity::GetTargetQuantityMax ( int attSlotID = -1 )

protected

Definition at line 2268 of file entityai.c.

GetTemperature()

float Entity::GetTemperature ( )

protected

Definition at line 2457 of file entityai.c.

GetTemperatureFreezeThreshold()

float Entity::GetTemperatureFreezeThreshold ( )

protected

Definition at line 2492 of file entityai.c.

GetTemperatureFreezeTime()

float Entity::GetTemperatureFreezeTime ( )

protected

Definition at line 2502 of file entityai.c.

GetTemperatureInit()

float Entity::GetTemperatureInit ( )

protected

Definition at line 2462 of file entityai.c.

GetTemperatureMax()

float Entity::GetTemperatureMax ( )

protected

Definition at line 2472 of file entityai.c.

GetTemperatureMin()

float Entity::GetTemperatureMin ( )

protected

Definition at line 2467 of file entityai.c.

GetTemperatureThawThreshold()

float Entity::GetTemperatureThawThreshold ( )

protected

Definition at line 2497 of file entityai.c.

GetTemperatureThawTime()

float Entity::GetTemperatureThawTime ( )

protected

Definition at line 2507 of file entityai.c.

GetTurnableValveIndex()

int Entity::GetTurnableValveIndex ( int pComponentIndex )

protected

GetUniversalTemperatureSource()

UTemperatureSource Entity::GetUniversalTemperatureSource ( )

protected

Definition at line 4176 of file entityai.c.

GetUniversalTemperatureSourcePosition()

vector Entity::GetUniversalTemperatureSourcePosition ( )

protected

Definition at line 4186 of file entityai.c.

GetVariablesFloat()

array< float > Entity::GetVariablesFloat ( )

protected

Definition at line 3154 of file entityai.c.

GetViewIndex()

int Entity::GetViewIndex ( )

protected

Returns item preview index !!!! IF OVERRIDING with more dynamic events call GetOnViewIndexChanged() in constructor on client !!!!

Definition at line 3730 of file entityai.c.

GetWeight()

int Entity::GetWeight ( )

protected

Definition at line 3548 of file entityai.c.

GetWeightEx()

float Entity::GetWeightEx ( bool forceRecalc = false )

protected

returns overall weight of the entity, 'forceRecalc = true' is meant to be used only when debugging, using it in gameplay code is higly inadvisable as it bypasses the weight caching and has adverse effect on performance

Definition at line 3613 of file entityai.c.

GetWeightSpecialized()

float Entity::GetWeightSpecialized ( bool forceRecalc = false )

protected

returns weight of the entity in a way that's specific to the entity type and is internal to the weight system calculation, to obtain entity's weight, use the 'GetWeightEx' method instead

Definition at line 3606 of file entityai.c.

GetWet()

float Entity::GetWet ( )

protected

Definition at line 2184 of file entityai.c.

GetWetInit()

float Entity::GetWetInit ( )

protected

Definition at line 2199 of file entityai.c.

GetWetLevel()

EWetnessLevel Entity::GetWetLevel ( )

protected

GetWetLevelInternal()

EWetnessLevel Entity::GetWetLevelInternal ( float wetness )

staticprotected

Definition at line 2216 of file entityai.c.

GetWetMax()

float Entity::GetWetMax ( )

protected

Definition at line 2189 of file entityai.c.

GetWetMin()

float Entity::GetWetMin ( )

protected

Definition at line 2194 of file entityai.c.

GetWetWeightModifier()

float Entity::GetWetWeightModifier ( )

protected

Definition at line 3525 of file entityai.c.

HandleFreezingProgression()

void Entity::HandleFreezingProgression ( float deltaHeat, TemperatureData data )

protected

Definition at line 2556 of file entityai.c.

HandleItemOverheating()

void Entity::HandleItemOverheating ( float deltaHeat, TemperatureData data )

protected

Definition at line 2698 of file entityai.c.

HasAnyCargo()

bool Entity::HasAnyCargo ( )

protected

is this container empty or not, checks only cargo

Definition at line 678 of file entityai.c.

HasBayonetAttached()

bool Entity::HasBayonetAttached ( )

protected

Definition at line 4005 of file entityai.c.

HasButtstockAttached()

bool Entity::HasButtstockAttached ( )

protected

Definition at line 4009 of file entityai.c.

HasEnergyManager()

bool Entity::HasEnergyManager ( )

protected

If this item has class EnergyManager in its config then it returns true. Otherwise returns false.

Definition at line 3421 of file entityai.c.

HasFlammableMaterial()

bool Entity::HasFlammableMaterial ( )

protected

Override this method to return TRUE when this item has or can provide fire. Evaluated on server and client.

Definition at line 540 of file entityai.c.

HasQuantity()

bool Entity::HasQuantity ( )

protected

Definition at line 2237 of file entityai.c.

HasTurnableValveBehavior()

bool Entity::HasTurnableValveBehavior ( )

protected

Turnable Valve behaviour.

HasWetness()

bool Entity::HasWetness ( )

protected

Definition at line 2204 of file entityai.c.

HeightCheckOverride()

float Entity::HeightCheckOverride ( )

protected

used as script-side override of distance for specific height checks

Definition at line 648 of file entityai.c.

HeightStartCheckOverride()

float Entity::HeightStartCheckOverride ( )

protected

used as script-side override of start pos for specific height checks

Definition at line 654 of file entityai.c.

HideAllSelections()

void Entity::HideAllSelections ( )

protected

Sets all animation values to 1, making them INVISIBLE if they are configured in models.cfg in such way. These selections must also be defined in the entity's config class in 'AnimationSources'.

Definition at line 1403 of file entityai.c.

HideSelection()

void Entity::HideSelection ( string selection_name )

protected

Hides selection of the given name. Must be configed in config.cpp and models.cfg.

Definition at line 3356 of file entityai.c.

IgnoreOutOfReachCondition()

bool Entity::IgnoreOutOfReachCondition ( )

protected

Returns

if true, attachment condition for out of reach (inventory) will be ignored

Definition at line 1808 of file entityai.c.

IncreaseLifetime()

proto native void Entity::IncreaseLifetime ( )

protected

Reset economy lifetime to default (seconds).

IncreaseLifetimeUp()

void Entity::IncreaseLifetimeUp ( )

protected

Reset economy lifetime to default across entity hierarchy all the way to the topmost entity.

Definition at line 3390 of file entityai.c.

InitGlobalExclusionValues()

void Entity::InitGlobalExclusionValues ( )

protected

override to init part of the mask, independent of slot-specific behavior

InitLegacyConfigExclusionValues()

void Entity::InitLegacyConfigExclusionValues ( )

protected

Definition at line 4258 of file entityai.c.

InitLegacyExclusionCheck()

bool Entity::InitLegacyExclusionCheck ( )

protected

Definition at line 4270 of file entityai.c.

InitLegacySlotExclusionValuesDerived()

void Entity::InitLegacySlotExclusionValuesDerived ( )

protected

Definition at line 4352 of file entityai.c.

InitLegacySlotExclusionValuesImplicit()

void Entity::InitLegacySlotExclusionValuesImplicit ( )

protected

adding base one-directional relations between headgear, masks, eyewear, and headstraps (exception)

Note

: 'InitLegacyConfigExclusionValues' adds them the other way if the item does not have any script-side exclusions AND has some legacy config parameter.

Definition at line 4298 of file entityai.c.

InitTemperature()

void Entity::InitTemperature ( )

protected

Definition at line 2285 of file entityai.c.

InsertAgent()

void Entity::InsertAgent ( int agent, float count = 1 )

protected

InterpolateTempData()

void Entity::InterpolateTempData ( TemperatureDataInterpolated data )

protected

Definition at line 2443 of file entityai.c.

IsAnimal()

bool Entity::IsAnimal ( )

protected

Definition at line 729 of file entityai.c.

IsBasebuildingKit()

bool Entity::IsBasebuildingKit ( )

protected

Definition at line 571 of file entityai.c.

IsBeingPlaced()

bool Entity::IsBeingPlaced ( )

protected

Definition at line 1685 of file entityai.c.

IsCookware()

bool Entity::IsCookware ( )

protected

Definition at line 576 of file entityai.c.

IsEmpty()

bool Entity::IsEmpty ( )

protected

is this container empty or not, checks both cargo and attachments

Definition at line 660 of file entityai.c.

IsEntityAI()

override bool Entity::IsEntityAI ( )

protected

Definition at line 717 of file entityai.c.

IsExclusionFlagPresent()

bool Entity::IsExclusionFlagPresent ( set< int > values )

protected

checks 'this' if the incoming flag is present for the current state (slot behavior and others)

Definition at line 4566 of file entityai.c.

IsExclusionFlagPresentRecursive()

bool Entity::IsExclusionFlagPresentRecursive ( set< int > values, int targetSlot )

protected

Gets flag from what is effectively an owner.

Definition at line 4583 of file entityai.c.

IsFreezeThawProgressFinished()

bool Entity::IsFreezeThawProgressFinished ( )

protected

on server only

Definition at line 2519 of file entityai.c.

IsHeavyBehaviour()

bool Entity::IsHeavyBehaviour ( )

protected

returns item behaviour of item (more in ItemBase)

Definition at line 3823 of file entityai.c.

IsHologram()

override bool Entity::IsHologram ( )

protected

Definition at line 1690 of file entityai.c.

IsIgnited()

bool Entity::IsIgnited ( )

protected

Override this method and make it so it returns whenever this item is on fire right now or not. Evaluated on Server and Client.

Definition at line 558 of file entityai.c.

IsIgnoredByConstruction()

bool Entity::IsIgnoredByConstruction ( )

protected

Definition at line 744 of file entityai.c.

IsInventoryVisible()

bool Entity::IsInventoryVisible ( )

protected

Definition at line 719 of file entityai.c.

IsItemOverheated()

bool Entity::IsItemOverheated ( )

protected

Definition at line 2665 of file entityai.c.

IsLockedInSlot()

bool Entity::IsLockedInSlot ( )

protected

Returns

true if entity is locked in attachment slot

Definition at line 1886 of file entityai.c.

IsManagingArrows()

bool Entity::IsManagingArrows ( )

protected

Definition at line 4694 of file entityai.c.

IsOneHandedBehaviour()

bool Entity::IsOneHandedBehaviour ( )

protected

returns item behaviour of item (more in ItemBase)

Definition at line 3829 of file entityai.c.

IsPilotLight()

proto native bool Entity::IsPilotLight ( )

protected

IsPlayer()

bool Entity::IsPlayer ( )

protected

Definition at line 724 of file entityai.c.

IsPreparedToDelete()

bool Entity::IsPreparedToDelete ( )

protected

Definition at line 829 of file entityai.c.

IsPrepareToDelete()

bool Entity::IsPrepareToDelete ( )

protected

Definition at line 843 of file entityai.c.

IsRequiredSimulation()

proto native bool Entity::IsRequiredSimulation ( )

protected

IsRoofAbove()

bool Entity::IsRoofAbove ( )

protected

Definition at line 698 of file entityai.c.

IsSelfAdjustingTemperature()

bool Entity::IsSelfAdjustingTemperature ( )

protected

Definition at line 3849 of file entityai.c.

IsServerCheck()

bool Entity::IsServerCheck ( bool allow_client )

protected

Definition at line 2768 of file entityai.c.

IsSetForDeletion()

bool Entity::IsSetForDeletion ( )

protected

Definition at line 807 of file entityai.c.

IsSimpleHiddenSelectionVisible()

proto native bool Entity::IsSimpleHiddenSelectionVisible ( int index )

protected

IsSkinned()

bool Entity::IsSkinned ( )

protected

Skinning.

Definition at line 497 of file entityai.c.

IsSlotReserved()

bool Entity::IsSlotReserved ( int slotID )

protected

Definition at line 1860 of file entityai.c.

IsSplitable()

bool Entity::IsSplitable ( )

protected

returns just the configured 'canBeSplit' bool

Definition at line 666 of file entityai.c.

IsStoreLoad()

bool Entity::IsStoreLoad ( )

protected

Definition at line 2747 of file entityai.c.

IsTakeable()

bool Entity::IsTakeable ( )

protected

Definition at line 1829 of file entityai.c.

IsTargetIgnitionSuccessful()

bool Entity::IsTargetIgnitionSuccessful ( EntityAI item_target )

protected

Final evaluation just before the target item is actually ignited. Evaluated on Server.

Definition at line 612 of file entityai.c.

IsThisIgnitionSuccessful()

bool Entity::IsThisIgnitionSuccessful ( EntityAI item_source = NULL )

protected

Final evaluation just before this item is actually ignited from fire source. Evaluated on Server.

Definition at line 618 of file entityai.c.

IsTwoHandedBehaviour()

bool Entity::IsTwoHandedBehaviour ( )

protected

returns item behaviour of item (more in ItemBase)

Definition at line 3835 of file entityai.c.

IsUniversalTemperatureSource()

bool Entity::IsUniversalTemperatureSource ( )

protected

Universal Temperature Sources Helpers.

Definition at line 4171 of file entityai.c.

IsValveTurnable()

bool Entity::IsValveTurnable ( int pValveIndex )

protected

IsVariableSet()

bool Entity::IsVariableSet ( int variable )

protected

'true' if this variable has ever been changed from default

Definition at line 3129 of file entityai.c.

IsZombie()

bool Entity::IsZombie ( )

protected

Definition at line 734 of file entityai.c.

IsZombieMilitary()

bool Entity::IsZombieMilitary ( )

protected

Definition at line 739 of file entityai.c.

KeepHealthOnReplace()

bool Entity::KeepHealthOnReplace ( )

protected

Definition at line 1099 of file entityai.c.

LoadVariables()

bool Entity::LoadVariables ( ParamsReadContext ctx, int version = -1 )

protected

Definition at line 3179 of file entityai.c.

LocalDropEntity()

bool Entity::LocalDropEntity ( notnull EntityAI item )

protected

Definition at line 2088 of file entityai.c.

LocalTakeEntityAsAttachment()

bool Entity::LocalTakeEntityAsAttachment ( notnull EntityAI item )

protected

Definition at line 2074 of file entityai.c.

LocalTakeEntityAsAttachmentEx()

bool Entity::LocalTakeEntityAsAttachmentEx ( notnull EntityAI item, int slot )

protected

Definition at line 2007 of file entityai.c.

LocalTakeEntityToCargo()

bool Entity::LocalTakeEntityToCargo ( notnull EntityAI item )

protected

Definition at line 1943 of file entityai.c.

LocalTakeEntityToCargoEx()

bool Entity::LocalTakeEntityToCargoEx ( notnull EntityAI item, int idx, int row, int col )

protected

Definition at line 1977 of file entityai.c.

LocalTakeEntityToInventory()

bool Entity::LocalTakeEntityToInventory ( FindInventoryLocationType flags, notnull EntityAI item )

protected

Definition at line 1910 of file entityai.c.

LocalTakeEntityToTargetAttachment()

bool Entity::LocalTakeEntityToTargetAttachment ( notnull EntityAI target, notnull EntityAI item )

protected

Definition at line 2039 of file entityai.c.

LocalTakeEntityToTargetAttachmentEx()

bool Entity::LocalTakeEntityToTargetAttachmentEx ( notnull EntityAI target, notnull EntityAI item, int slot )

protected

Definition at line 2023 of file entityai.c.

LocalTakeEntityToTargetCargo()

bool Entity::LocalTakeEntityToTargetCargo ( notnull EntityAI target, notnull EntityAI item )

protected

Definition at line 1959 of file entityai.c.

LocalTakeEntityToTargetCargoEx()

bool Entity::LocalTakeEntityToTargetCargoEx ( notnull CargoBase cargo, notnull EntityAI item, int row, int col )

protected

Definition at line 1989 of file entityai.c.

LocalTakeEntityToTargetInventory()

bool Entity::LocalTakeEntityToTargetInventory ( notnull EntityAI target, FindInventoryLocationType flags, notnull EntityAI item )

protected

Definition at line 1925 of file entityai.c.

LocalTakeToDst()

bool Entity::LocalTakeToDst ( notnull InventoryLocation src, notnull InventoryLocation dst )

protected

Definition at line 2055 of file entityai.c.

Log()

void Entity::Log ( string msg, string fnc_name = "n/a" )

protected

Log.

Definition at line 479 of file entityai.c.

LogError()

void Entity::LogError ( string msg, string fnc_name = "n/a" )

protected

LogError.

Definition at line 491 of file entityai.c.

LogWarning()

void Entity::LogWarning ( string msg, string fnc_name = "n/a" )

protected

LogWarning.

Definition at line 485 of file entityai.c.

OnAction()

bool Entity::OnAction ( int action_id, Man player, ParamsReadContext ctx )

protected

Definition at line 3657 of file entityai.c.

OnAttachmentRuined()

void Entity::OnAttachmentRuined ( EntityAI attachment )

protected

Called when some attachment of this parent is ruined. Called on server and client side.

OnBeforeTryDelete()

void Entity::OnBeforeTryDelete ( )

protected

OnBinLoadItemsDropped()

void Entity::OnBinLoadItemsDropped ( )

protected

Called when an item fails to get loaded into the inventory of an entity and gets dropped.

Definition at line 1396 of file entityai.c.

OnCargoChanged()

void Entity::OnCargoChanged ( )

protected

OnCEUpdate()

void Entity::OnCEUpdate ( )

protected

Central economy calls this function whenever going over all the entities.

void OnCEUpdate()
{
    // dont forget to propagate this call trough class hierarchy! - always at the start of the function
    super.OnCEUpdate();
 
    // use m_ElapsedSinceLastUpdate for time-related purposes
}

Definition at line 3866 of file entityai.c.

OnChildItemReceived()

void Entity::OnChildItemReceived ( InventoryItem item )

protected

OnChildItemRemoved()

void Entity::OnChildItemRemoved ( InventoryItem item )

protected

OnDamageDestroyed()

void Entity::OnDamageDestroyed ( int oldLevel )

protected

Called when the health gets to the min value, 'oldLevel' is previous health level, 'oldLevel' -1 means this entity was just spawned.

OnDebugButtonPressClient()

void Entity::OnDebugButtonPressClient ( int button_index )

protected

Definition at line 3321 of file entityai.c.

OnDebugButtonPressServer()

void Entity::OnDebugButtonPressServer ( int button_index )

protected

Definition at line 3322 of file entityai.c.

OnDebugSpawn()

void Entity::OnDebugSpawn ( )

protected

Definition at line 3907 of file entityai.c.

OnDebugSpawnEx()

void Entity::OnDebugSpawnEx ( DebugSpawnParams params )

protected

Definition at line 3902 of file entityai.c.

OnEnergyAdded()

void Entity::OnEnergyAdded ( )

protected

Energy manager event: Called when energy was added on this device. ALWAYS CALL super.OnEnergyAdded() !!!

Definition at line 3462 of file entityai.c.

OnEnergyConsumed()

void Entity::OnEnergyConsumed ( )

protected

Energy manager event: Called when energy was consumed on this device. ALWAYS CALL super.OnEnergyConsumed() !!!

Definition at line 3459 of file entityai.c.

OnExplosionEffects()

override void Entity::OnExplosionEffects ( Object source, Object directHit, int componentIndex, string surface, vector pos, vector surfNormal, float energyFactor, float explosionFactor, bool isWater, string ammoType )

protected

Definition at line 943 of file entityai.c.

OnFreezeStateChangeClient()

void Entity::OnFreezeStateChangeClient ( )

protected

OnFreezeStateChangeServer()

void Entity::OnFreezeStateChangeServer ( )

protected

OnHologramBeingPlaced()

void Entity::OnHologramBeingPlaced ( Man player )

protected

OnIgnitedTarget()

void Entity::OnIgnitedTarget ( EntityAI target_item )

protected

Executed on Server when this item ignites some target item.

Definition at line 588 of file entityai.c.

OnIgnitedTargetFailed()

void Entity::OnIgnitedTargetFailed ( EntityAI target_item )

protected

Executed on Server when this item failed to ignite target item.

Definition at line 600 of file entityai.c.

OnIgnitedThis()

void Entity::OnIgnitedThis ( EntityAI fire_source )

protected

Executed on Server when some item ignited this one.

Definition at line 594 of file entityai.c.

OnIgnitedThisFailed()

void Entity::OnIgnitedThisFailed ( EntityAI fire_source )

protected

Executed on Server when some item failed to ignite this one.

Definition at line 606 of file entityai.c.

OnInitEnergy()

void Entity::OnInitEnergy ( )

protected

Energy manager event: Object's initialization. Energy Manager is fully initialized by this point.

Definition at line 3456 of file entityai.c.

OnInventoryInit()

void Entity::OnInventoryInit ( )

protected

Definition at line 894 of file entityai.c.

OnIsPlugged()

void Entity::OnIsPlugged ( EntityAI source_device )

protected

Energy manager event: Called when this device is plugged into some energy source.

Definition at line 3444 of file entityai.c.

OnIsUnplugged()

void Entity::OnIsUnplugged ( EntityAI last_energy_source )

protected

Energy manager event: Called when this device is UNPLUGGED from the energy source.

Definition at line 3447 of file entityai.c.

OnItemAttachmentSlotChanged()

void Entity::OnItemAttachmentSlotChanged ( notnull InventoryLocation oldLoc, notnull InventoryLocation newLoc )

protected

OnItemLocationChanged()

void Entity::OnItemLocationChanged ( EntityAI old_owner, EntityAI new_owner )

protected

OnItemOverheat()

void Entity::OnItemOverheat ( float deltaTime )

protected

OnItemOverheatEnd()

void Entity::OnItemOverheatEnd ( )

protected

note, that the deltaTime could be reverse-calculated and not totally accurate

OnItemOverheatStart()

void Entity::OnItemOverheatStart ( )

protected

override to implement desired overheat behavior on entity

OnMovedInsideCargo()

void Entity::OnMovedInsideCargo ( EntityAI container )

protected

Called when this item enters cargo of some container.

Definition at line 1334 of file entityai.c.

OnMovedWithinCargo()

void Entity::OnMovedWithinCargo ( EntityAI container )

protected

Called when this item moves within cargo of some container.

Definition at line 1347 of file entityai.c.

OnOwnSocketReleased()

void Entity::OnOwnSocketReleased ( EntityAI device )

protected

Energy manager event: When something is UNPLUGGED from this device.

Definition at line 3453 of file entityai.c.

OnOwnSocketTaken()

void Entity::OnOwnSocketTaken ( EntityAI device )

protected

Energy manager event: When something is plugged into this device.

Definition at line 3450 of file entityai.c.

OnPlacementCancelled()

void Entity::OnPlacementCancelled ( Man player )

protected

OnPlacementComplete()

void Entity::OnPlacementComplete ( Man player, vector position = "0 0 0", vector orientation = "0 0 0" )

protected

OnPlacementStarted()

void Entity::OnPlacementStarted ( Man player )

protected

OnRemovedFromCargo()

void Entity::OnRemovedFromCargo ( EntityAI container )

protected

Called when this item exits cargo of some container.

Definition at line 1341 of file entityai.c.

OnRPC()

override void Entity::OnRPC ( PlayerIdentity sender, int rpc_type, ParamsReadContext ctx )

protected

Definition at line 3465 of file entityai.c.

OnStoreLoad()

bool Entity::OnStoreLoad ( ParamsReadContext ctx, int version )

protected

Called when data is loaded from persistence (on server side).

void OnStoreLoad(ParamsReadContext ctx, int version)
{
    // dont forget to propagate this call trough class hierarchy!
    if ( !super.OnStoreLoad(ctx, version) )
        return false;
 
    // read data loaded from game database (format and order of reading must be the same as writing!)
    int a;
    if ( !ctx.Read(a) )
        return false;
 
    float b;
    if ( !ctx.Read(b) )
        return false;
 
    return true;
}

Definition at line 2989 of file entityai.c.

OnStoreSave()

void Entity::OnStoreSave ( ParamsWriteContext ctx )

protected

Engine calls this function to collect data from entity to store for persistence (on server side).

void OnStoreSave(ParamsWriteContext ctx)
{
    // dont forget to propagate this call trough class hierarchy!
    super.OnStoreSave(ctx);
 
    // write any data (using params) you want to store
    int   a = 5;
    float b = 6.0;
 
    ctx.Write(a);
    ctx.Write(b);
}

Definition at line 2925 of file entityai.c.

OnSwitchOff()

void Entity::OnSwitchOff ( )

protected

Energy manager event: Called when the device is switched OFF.

Definition at line 3441 of file entityai.c.

OnSwitchOn()

void Entity::OnSwitchOn ( )

protected

Energy manager event: Called when the device is switched on.

Definition at line 3438 of file entityai.c.

OnVariablesSynchronized()

void Entity::OnVariablesSynchronized ( )

protected

Called on clients after receiving synchronization data from server.

Definition at line 3074 of file entityai.c.

OnWasAttached()

void Entity::OnWasAttached ( EntityAI parent, int slot_id )

protected

OnWasDetached()

void Entity::OnWasDetached ( EntityAI parent, int slot_id )

protected

Definition at line 1817 of file entityai.c.

OnWetChanged()

void Entity::OnWetChanged ( float newVal, float oldVal )

protected

OnWetLevelChanged()

void Entity::OnWetLevelChanged ( EWetnessLevel newLevel, EWetnessLevel oldLevel )

protected

OnWork()

void Entity::OnWork ( float consumed_energy )

protected

Energy manager event: Called every device update if its supposed to do some work. The update can be every second or at random, depending on its manipulation.

Definition at line 3432 of file entityai.c.

OnWorkStart()

void Entity::OnWorkStart ( )

protected

Energy manager event: Called only once when this device starts doing its work.

Definition at line 3429 of file entityai.c.

OnWorkStop()

void Entity::OnWorkStop ( )

protected

Energy manager event: Called when the device stops working (was switched OFF or ran out of energy).

Definition at line 3435 of file entityai.c.

PairRemote()

void Entity::PairRemote ( notnull EntityAI trigger )

protected

PlacementCanBeRotated()

bool Entity::PlacementCanBeRotated ( )

protected

Should return false if you want to disable hologram rotation.

Definition at line 582 of file entityai.c.

PlaceOnSurfaceRotated()

proto native void Entity::PlaceOnSurfaceRotated ( out vector trans[4], vector pos, float dx = 0, float dz = 0, float fAngle = 0, bool align = false )

protected

PredictiveDropEntity()

bool Entity::PredictiveDropEntity ( notnull EntityAI item )

protected

Definition at line 2083 of file entityai.c.

PredictiveTakeEntityAsAttachment()

bool Entity::PredictiveTakeEntityAsAttachment ( notnull EntityAI item )

protected

Put item into as attachment.

Definition at line 2067 of file entityai.c.

PredictiveTakeEntityAsAttachmentEx()

bool Entity::PredictiveTakeEntityAsAttachmentEx ( notnull EntityAI item, int slot )

protected

Returns if item can be added as attachment on specific slot. Note that slot index IS NOT slot ID! Slot ID is defined in DZ/data/config.cpp.

Definition at line 2000 of file entityai.c.

PredictiveTakeEntityToCargo()

bool Entity::PredictiveTakeEntityToCargo ( notnull EntityAI item )

protected

Put item into into cargo.

Definition at line 1936 of file entityai.c.

PredictiveTakeEntityToCargoEx()

bool Entity::PredictiveTakeEntityToCargoEx ( notnull EntityAI item, int idx, int row, int col )

protected

Put item into into cargo on specific cargo location.

Definition at line 1970 of file entityai.c.

PredictiveTakeEntityToInventory()

bool Entity::PredictiveTakeEntityToInventory ( FindInventoryLocationType flags, notnull EntityAI item )

protected

Put item anywhere into this entity (as attachment or into cargo, recursively).

Definition at line 1903 of file entityai.c.

PredictiveTakeEntityToTargetAttachment()

bool Entity::PredictiveTakeEntityToTargetAttachment ( notnull EntityAI target, notnull EntityAI item )

protected

Definition at line 2032 of file entityai.c.

PredictiveTakeEntityToTargetAttachmentEx()

bool Entity::PredictiveTakeEntityToTargetAttachmentEx ( notnull EntityAI target, notnull EntityAI item, int slot )

protected

Definition at line 2016 of file entityai.c.

PredictiveTakeEntityToTargetCargo()

bool Entity::PredictiveTakeEntityToTargetCargo ( notnull EntityAI target, notnull EntityAI item )

protected

Definition at line 1952 of file entityai.c.

PredictiveTakeEntityToTargetCargoEx()

bool Entity::PredictiveTakeEntityToTargetCargoEx ( notnull CargoBase cargo, notnull EntityAI item, int row, int col )

protected

Definition at line 1982 of file entityai.c.

PredictiveTakeEntityToTargetInventory()

bool Entity::PredictiveTakeEntityToTargetInventory ( notnull EntityAI target, FindInventoryLocationType flags, notnull EntityAI item )

protected

Definition at line 1918 of file entityai.c.

PredictiveTakeToDst()

bool Entity::PredictiveTakeToDst ( notnull InventoryLocation src, notnull InventoryLocation dst )

protected

Definition at line 2048 of file entityai.c.

ProcessInvulnerabilityCheck()

void Entity::ProcessInvulnerabilityCheck ( string servercfg_param )

protected

Definition at line 3981 of file entityai.c.

ProcessMeleeItemDamage()

override EntityAI Entity::ProcessMeleeItemDamage ( int mode = 0 )

protected

Definition at line 3963 of file entityai.c.

ProcessVariables()

void Entity::ProcessVariables ( )

protected

Definition at line 3878 of file entityai.c.

ReadVarsFromCTX()

bool Entity::ReadVarsFromCTX ( ParamsReadContext ctx, int version = -1 )

protected

Reads from storage CTX.

Definition at line 3212 of file entityai.c.

RefreshTemperatureAccess()

void Entity::RefreshTemperatureAccess ( TemperatureData data )

protected

refreshes access without setting temperature, keeps the source locked in

Definition at line 2432 of file entityai.c.

RegisterNetSyncVariableBool()

proto native void Entity::RegisterNetSyncVariableBool ( string variableName )

protected

registers bool variable synchronized over network

Parameters

[in]

variableName

which variable should be synchronized

RegisterNetSyncVariableBoolSignal()

proto native void Entity::RegisterNetSyncVariableBoolSignal ( string variableName )

protected

when bool variable is true, it's sent to clients and become false again

Parameters

[in]

variableName

which variable should be synchronized

RegisterNetSyncVariableFloat()

proto native void Entity::RegisterNetSyncVariableFloat ( string variableName, float minValue = 0, float maxValue = 0, int precision = 1 )

protected

registers float variable synchronized over network

Parameters

[in]	variableName	which variable should be synchronized
[in]	minValue	minimal value used for quantization (when minValue == maxValue, no quatization is done)
[in]	maxValue	maximal value used for quantization (when minValue == maxValue, no quatization is done)
[in]	precision	precision in number of digits after decimal point

RegisterNetSyncVariableInt()

proto native void Entity::RegisterNetSyncVariableInt ( string variableName, int minValue = 0, int maxValue = 0 )

protected

registers int variable synchronized over network

Parameters

[in]	variableName	which variable should be synchronized
[in]	minValue	minimal value used for quantization (when minValue == maxValue, no quatization is done)
[in]	maxValue	maximal value used for quantization (when minValue == maxValue, no quatization is done)

RegisterNetSyncVariableObject()

proto native void Entity::RegisterNetSyncVariableObject ( string variableName )

protected

registers object variable synchronized over network, only synchronizes if network id is assigned. Doesn't handle object despawn on client

Parameters

[in]

variableName

which variable should be synchronized

RegisterTransportHit()

void Entity::RegisterTransportHit ( Transport transport )

protected

Definition at line 4086 of file entityai.c.

RemoveAgent()

void Entity::RemoveAgent ( int agent_id )

protected

RemoveAllAgents()

void Entity::RemoveAllAgents ( )

protected

RemoveAllAgentsExcept()

void Entity::RemoveAllAgentsExcept ( int agent_to_keep )

protected

RemoveItemVariable()

void Entity::RemoveItemVariable ( int variable )

protected

Removes variable from variable mask, making it appear as though the variable has never been changed from default.

Definition at line 3144 of file entityai.c.

ReplaceOnDeath()

bool Entity::ReplaceOnDeath ( )

protected

Definition at line 1089 of file entityai.c.

SaveVariables()

void Entity::SaveVariables ( ParamsWriteContext ctx )

protected

Definition at line 3161 of file entityai.c.

SerializeNumericalVars()

void Entity::SerializeNumericalVars ( array< float > floats_out )

protected

Definition at line 3240 of file entityai.c.

ServerDropEntity()

bool Entity::ServerDropEntity ( notnull EntityAI item )

protected

Definition at line 2093 of file entityai.c.

ServerTakeEntityAsAttachment()

bool Entity::ServerTakeEntityAsAttachment ( notnull EntityAI item )

protected

Definition at line 2078 of file entityai.c.

ServerTakeEntityAsAttachmentEx()

bool Entity::ServerTakeEntityAsAttachmentEx ( notnull EntityAI item, int slot )

protected

Definition at line 2011 of file entityai.c.

ServerTakeEntityToCargo()

bool Entity::ServerTakeEntityToCargo ( notnull EntityAI item )

protected

Definition at line 1947 of file entityai.c.

ServerTakeEntityToInventory()

bool Entity::ServerTakeEntityToInventory ( FindInventoryLocationType flags, notnull EntityAI item )

protected

Definition at line 1914 of file entityai.c.

ServerTakeEntityToTargetAttachment()

bool Entity::ServerTakeEntityToTargetAttachment ( notnull EntityAI target, notnull EntityAI item )

protected

Definition at line 2043 of file entityai.c.

ServerTakeEntityToTargetAttachmentEx()

bool Entity::ServerTakeEntityToTargetAttachmentEx ( notnull EntityAI target, notnull EntityAI item, int slot )

protected

Definition at line 2027 of file entityai.c.

ServerTakeEntityToTargetCargo()

bool Entity::ServerTakeEntityToTargetCargo ( notnull EntityAI target, notnull EntityAI item )

protected

Definition at line 1963 of file entityai.c.

ServerTakeEntityToTargetCargoEx()

bool Entity::ServerTakeEntityToTargetCargoEx ( notnull CargoBase cargo, notnull EntityAI item, int row, int col )

protected

Definition at line 1993 of file entityai.c.

ServerTakeEntityToTargetInventory()

bool Entity::ServerTakeEntityToTargetInventory ( notnull EntityAI target, FindInventoryLocationType flags, notnull EntityAI item )

protected

Definition at line 1929 of file entityai.c.

ServerTakeToDst()

bool Entity::ServerTakeToDst ( notnull InventoryLocation src, notnull InventoryLocation dst )

protected

Definition at line 2059 of file entityai.c.

SetAITargetCallbacks()

proto native void Entity::SetAITargetCallbacks ( AbstractAITargetCallbacks callbacks )

protected

SetAsSkinned()

void Entity::SetAsSkinned ( )

protected

Definition at line 502 of file entityai.c.

SetAttachmentExclusionMaskGlobal()

void Entity::SetAttachmentExclusionMaskGlobal ( set< int > values )

protected

Definition at line 4454 of file entityai.c.

SetAttachmentExclusionMaskSlot()

void Entity::SetAttachmentExclusionMaskSlot ( int slotId, set< int > values )

protected

sets values for specific slot

Definition at line 4461 of file entityai.c.

SetBayonetAttached()

void Entity::SetBayonetAttached ( bool pState, int slot_idx = -1 )

protected

Definition at line 4004 of file entityai.c.

SetButtstockAttached()

void Entity::SetButtstockAttached ( bool pState, int slot_idx = -1 )

protected

Definition at line 4008 of file entityai.c.

SetCleanness()

void Entity::SetCleanness ( int value, bool allow_client = false )

protected

SetColor()

void Entity::SetColor ( int r, int g, int b, int a )

protected

SetFreezeThawProgress()

void Entity::SetFreezeThawProgress ( float val )

protected

0->1 when freezing, 1->0 when thawing

Definition at line 2525 of file entityai.c.

SetFromProjectile()

void Entity::SetFromProjectile ( ProjectileStoppedInfo info )

protected

Definition at line 4704 of file entityai.c.

SetFrozen()

void Entity::SetFrozen ( bool frozen )

protected

Definition at line 2540 of file entityai.c.

SetInvisibleRecursive()

void Entity::SetInvisibleRecursive ( bool invisible, EntityAI parent = null, array< int > attachments = null )

protected

Definition at line 4012 of file entityai.c.

SetItemOverheatProgress()

void Entity::SetItemOverheatProgress ( float val, float deltaTime = 0 )

protected

Definition at line 2675 of file entityai.c.

SetLifetime()

proto native void Entity::SetLifetime ( float fLifeTime )

protected

Set (override) remaining economy lifetime (seconds).

SetLifetimeMax()

proto native void Entity::SetLifetimeMax ( float fLifeTime )

protected

Set (override) max economy lifetime per entity instance (seconds).

SetLiquidType()

void Entity::SetLiquidType ( int value, bool allow_client = false )

protected

SetObjectMaterial()

proto native void Entity::SetObjectMaterial ( int index, string mat_name )

protected

Change material in hiddenSelections.

SetObjectTexture()

proto native void Entity::SetObjectTexture ( int index, string texture_name )

protected

Change texture in hiddenSelections.

SetPersistentPairID()

void Entity::SetPersistentPairID ( int id )

protected

Definition at line 4200 of file entityai.c.

SetPilotLight()

proto native void Entity::SetPilotLight ( bool isOn )

protected

SetPrepareToDelete()

void Entity::SetPrepareToDelete ( )

protected

Definition at line 824 of file entityai.c.

SetQuantity()

bool Entity::SetQuantity ( float value, bool destroy_config = true, bool destroy_forced = false, bool allow_client = false, bool clamp_to_stack_max = true )

protected

SetQuantityNormalized()

void Entity::SetQuantityNormalized ( float value, bool destroy_config = true, bool destroy_forced = false )

protected

SetQuantityToMinimum()

void Entity::SetQuantityToMinimum ( )

protected

SetRequiredSimulation()

proto native void Entity::SetRequiredSimulation ( bool req )

protected

SetRoofAbove()

void Entity::SetRoofAbove ( bool state )

protected

Definition at line 703 of file entityai.c.

SetSimpleHiddenSelectionState()

proto native void Entity::SetSimpleHiddenSelectionState ( int index, bool state )

protected

Simple hidden selection state; 0 == hidden.

SetStoreLoad()

void Entity::SetStoreLoad ( bool value )

protected

SetStoreLoadedQuantity()

void Entity::SetStoreLoadedQuantity ( float value )

protected

SetSynchDirty()

proto native void Entity::SetSynchDirty ( )

protected

Sets object synchronization dirty flag, which signalize that object wants to be synchronized (take effect only in MP on server side).

SetTakeable()

void Entity::SetTakeable ( bool pState )

protected

SetTemperature()

void Entity::SetTemperature ( float value, bool allow_client = false )

protected

not really deprecated, but missing context info from TemperatureData. Default values used instead.

Definition at line 2323 of file entityai.c.

SetTemperatureDirect()

void Entity::SetTemperatureDirect ( float value, bool allow_client = false )

protected

Definition at line 2308 of file entityai.c.

SetTemperatureEx()

void Entity::SetTemperatureEx ( TemperatureData data )

protected

sets temperature, handles base overheating and freezing state progression logics

CanFreeze

Definition at line 2342 of file entityai.c.

SetTemperatureMax()

void Entity::SetTemperatureMax ( )

protected

presumably for debug purposes?

Definition at line 2451 of file entityai.c.

SetUniversalTemperatureSource()

void Entity::SetUniversalTemperatureSource ( UTemperatureSource uts )

protected

Definition at line 4181 of file entityai.c.

SetVariableMask()

void Entity::SetVariableMask ( int variable )

protected

Definition at line 3134 of file entityai.c.

SetViewIndex()

void Entity::SetViewIndex ( int index )

protected

Sets item preview index.

Definition at line 3719 of file entityai.c.

SetWeightDirty()

void Entity::SetWeightDirty ( )

protected

Definition at line 3559 of file entityai.c.

SetWet()

void Entity::SetWet ( float value, bool allow_client = false )

protected

SetWetMax()

void Entity::SetWetMax ( )

protected

ShowAllSelections()

void Entity::ShowAllSelections ( )

protected

Sets all animation values to 0, making them VISIBLE if they are configured in models.cfg in such way. These selections must also be defined in the entity's config class in 'AnimationSources'.

Definition at line 1421 of file entityai.c.

ShowSelection()

void Entity::ShowSelection ( string selection_name )

protected

Shows selection of the given name. Must be configed in config.hpp and models.cfg.

Definition at line 3365 of file entityai.c.

SoundHardBushFallingPlay()

void Entity::SoundHardBushFallingPlay ( )

protected

Definition at line 4074 of file entityai.c.

SoundHardTreeFallingPlay()

void Entity::SoundHardTreeFallingPlay ( )

protected

Definition at line 4062 of file entityai.c.

SoundSoftBushFallingPlay()

void Entity::SoundSoftBushFallingPlay ( )

protected

Definition at line 4080 of file entityai.c.

SoundSoftTreeFallingPlay()

void Entity::SoundSoftTreeFallingPlay ( )

protected

Definition at line 4068 of file entityai.c.

SpawnEntityOnGround()

EntityAI Entity::SpawnEntityOnGround ( string object_name, vector mat[4] )

protected

Definition at line 2164 of file entityai.c.

SpawnEntityOnGroundPos()

EntityAI Entity::SpawnEntityOnGroundPos ( string object_name, vector pos )

protected

Definition at line 2153 of file entityai.c.

SpawnInInventoryOrGroundPos()

EntityAI Entity::SpawnInInventoryOrGroundPos ( string object_name, GameInventory inv, vector pos )

protected

Definition at line 2137 of file entityai.c.

SplitIntoStackMaxClient()

void Entity::SplitIntoStackMaxClient ( EntityAI destination_entity, int slot_id )

protected

SplitIntoStackMaxEx()

void Entity::SplitIntoStackMaxEx ( EntityAI destination_entity, int slot_id )

protected

SwitchItemSelectionTexture()

void Entity::SwitchItemSelectionTexture ( EntityAI item, string slot_name )

protected

SwitchItemSelectionTextureEx()

void Entity::SwitchItemSelectionTextureEx ( EItemManipulationContext context, Param par = null )

protected

SwitchLight()

proto native void Entity::SwitchLight ( bool isOn )

protected

TransferVariablesFloat()

void Entity::TransferVariablesFloat ( array< float > float_vars )

protected

Definition at line 3149 of file entityai.c.

TranslateSlotFromSelection()

bool Entity::TranslateSlotFromSelection ( string selection_name, out int slot_id )

protected

Definition at line 4165 of file entityai.c.

TryDelete()

bool Entity::TryDelete ( )

protected

Definition at line 848 of file entityai.c.

UnpairRemote()

void Entity::UnpairRemote ( )

protected

UpdateNetSyncVariableFloat()

proto native void Entity::UpdateNetSyncVariableFloat ( string variableName, float minValue = 0, float maxValue = 0, int precision = 1 )

protected

UpdateNetSyncVariableInt()

proto native void Entity::UpdateNetSyncVariableInt ( string variableName, float minValue = 0, float maxValue = 0 )

protected

UpdateWeight()

void Entity::UpdateWeight ( WeightUpdateType updateType = WeightUpdateType.FULL, float weightAdjustment = 0 )

protected

UseConfigInitTemperature()

bool Entity::UseConfigInitTemperature ( )

protected

Definition at line 2280 of file entityai.c.

WriteVarsToCTX()

void Entity::WriteVarsToCTX ( ParamsWriteContext ctx )

protected

Writes to storage CTX.

Definition at line 3199 of file entityai.c.

Member Data Documentation

m_CanDisplayWeight

bool Entity::m_CanDisplayWeight

protected

Definition at line 136 of file entityai.c.

m_DamageZoneMap

ref DamageZoneMap Entity::m_DamageZoneMap

protected

Definition at line 130 of file entityai.c.

m_ElapsedSinceLastUpdate

float Entity::m_ElapsedSinceLastUpdate

protected

Definition at line 138 of file entityai.c.

m_FreezeThawProgress

float Entity::m_FreezeThawProgress

protected

Definition at line 169 of file entityai.c.

m_Initialized

bool Entity::m_Initialized = false

protected

Definition at line 144 of file entityai.c.

m_IsFrozen

bool Entity::m_IsFrozen

protected

Definition at line 167 of file entityai.c.

m_IsFrozenLocal

bool Entity::m_IsFrozenLocal

protected

Definition at line 168 of file entityai.c.

m_OnAttachmentReleaseLock

ref ScriptInvoker Entity::m_OnAttachmentReleaseLock

protected

Definition at line 196 of file entityai.c.

m_OnAttachmentSetLock

ref ScriptInvoker Entity::m_OnAttachmentSetLock

protected

Definition at line 194 of file entityai.c.

m_OnHitByInvoker

ref ScriptInvoker Entity::m_OnHitByInvoker

protected

Definition at line 198 of file entityai.c.

m_OnItemAddedIntoCargo

ref ScriptInvoker Entity::m_OnItemAddedIntoCargo

protected

Definition at line 180 of file entityai.c.

m_OnItemAttached

ref ScriptInvoker Entity::m_OnItemAttached

protected

Definition at line 176 of file entityai.c.

m_OnItemDetached

ref ScriptInvoker Entity::m_OnItemDetached

protected

Definition at line 178 of file entityai.c.

m_OnItemFlipped

ref ScriptInvoker Entity::m_OnItemFlipped

protected

Definition at line 186 of file entityai.c.

m_OnItemMovedInCargo

ref ScriptInvoker Entity::m_OnItemMovedInCargo

protected

Definition at line 184 of file entityai.c.

m_OnItemRemovedFromCargo

ref ScriptInvoker Entity::m_OnItemRemovedFromCargo

protected

Definition at line 182 of file entityai.c.

m_OnKilledInvoker

ref ScriptInvoker Entity::m_OnKilledInvoker

protected

Definition at line 200 of file entityai.c.

m_OnReleaseLock

ref ScriptInvoker Entity::m_OnReleaseLock

protected

Definition at line 192 of file entityai.c.

m_OnSetLock

ref ScriptInvoker Entity::m_OnSetLock

protected

Definition at line 190 of file entityai.c.

m_OnViewIndexChanged

ref ScriptInvoker Entity::m_OnViewIndexChanged

protected

Definition at line 188 of file entityai.c.

m_OverheatProgress

float Entity::m_OverheatProgress

protected

Definition at line 171 of file entityai.c.

m_PendingDelete

bool Entity::m_PendingDelete = false

protected

Definition at line 143 of file entityai.c.

m_PreviousRoofTestTime

float Entity::m_PreviousRoofTestTime = 0

protected

Definition at line 139 of file entityai.c.

m_RoofAbove

bool Entity::m_RoofAbove = false

protected

Definition at line 113 of file entityai.c.

m_TAC

ref TemperatureAccessComponent Entity::m_TAC

protected

Definition at line 165 of file entityai.c.

m_TransportHitRegistered

bool Entity::m_TransportHitRegistered = false

protected

Definition at line 145 of file entityai.c.

m_TransportHitVelocity

vector Entity::m_TransportHitVelocity

protected

Definition at line 146 of file entityai.c.

m_UniversalTemperatureSource

UTemperatureSource Entity::m_UniversalTemperatureSource

protected

Definition at line 141 of file entityai.c.

m_VarHeatPermeabilityCoef

float Entity::m_VarHeatPermeabilityCoef

protected

Definition at line 163 of file entityai.c.

m_VariablesMask

int Entity::m_VariablesMask

protected

Definition at line 151 of file entityai.c.

m_VarTemperature

float Entity::m_VarTemperature

protected

Definition at line 154 of file entityai.c.

m_VarTemperatureFreezeThreshold

float Entity::m_VarTemperatureFreezeThreshold

protected

Definition at line 158 of file entityai.c.

m_VarTemperatureFreezeTime

float Entity::m_VarTemperatureFreezeTime

protected

Definition at line 160 of file entityai.c.

m_VarTemperatureInit

float Entity::m_VarTemperatureInit

protected

Definition at line 155 of file entityai.c.

m_VarTemperatureMax

float Entity::m_VarTemperatureMax

protected

Definition at line 157 of file entityai.c.

m_VarTemperatureMin

float Entity::m_VarTemperatureMin

protected

Definition at line 156 of file entityai.c.

m_VarTemperatureOverheatTime

float Entity::m_VarTemperatureOverheatTime

protected

Definition at line 162 of file entityai.c.

m_VarTemperatureThawThreshold

float Entity::m_VarTemperatureThawThreshold

protected

Definition at line 159 of file entityai.c.

m_VarTemperatureThawTime

float Entity::m_VarTemperatureThawTime

protected

Definition at line 161 of file entityai.c.

m_ViewIndex

int Entity::m_ViewIndex = 0

protected

view index Item view index is used to setup which camera will be used in item view widget in inventory. With this index you can setup various camera angles for different item states (e.g. fireplace, weapons).

Definition at line 3716 of file entityai.c.

---

The documentation for this class was generated from the following files:

• Daten/3_game/entities/camera.c
• Daten/3_game/entities/entityai.c
• Daten/3_game/entities/entitylightsource.c
• Daten/3_game/entities/soundonvehicle.c