Engine.InventoryManager

Extends

Actor

Modifiers

native

Core.Object
|   
+-- Engine.Actor
   |   
   +-- Engine.InventoryManager

Direct Known Subclasses:

UTInventoryManager

Functions Summary
	bool	AddInventory (Inventory NewItem, optional bool bDoNotActivate))
	bool	CancelWeaponChange ()))
		ChangedWeapon ()))
		ClientSyncWeapon (Weapon NewWeapon))
		ClientWeaponSet (Weapon NewWeapon, bool bOptionalSet))
	Inventory	CreateInventory (class<Inventory> NewInventoryItemClass, optional bool bDoNotActivate))
		Destroyed ()))
		DiscardInventory ()))
		DrawHud (HUD H ))
		DumpWeaponStats ()))
	Inventory	FindInventoryType (class<Inventory> DesiredClass, optional bool bAllowSubclass))
	Weapon	GetBestWeapon (optional bool bForceADifferentWeapon ))
	float	GetWeaponRatingFor (Weapon W ))
	bool	HandlePickupQuery (class<Inventory> ItemClass, Actor Pickup))
		InventoryActors (class<Inventory> BaseClass, out Inventory Inv)
	bool	IsActiveWeapon (Weapon ThisWeapon ))
	int	ModifyDamage (int Damage, Controller instigatedBy, vector HitLocation, vector Momentum, class DamageType ))
		NextWeapon ()))
		OwnerEvent (name EventName))
		PostBeginPlay ()))
		PrevWeapon ()))
		RemoveFromInventory (Inventory ItemToRemove))
		ServerSetCurrentWeapon (Weapon DesiredWeapon))
		SetCurrentWeapon (Weapon DesiredWeapon))
		SetPendingWeapon (Weapon DesiredWeapon))
		SetupFor (Pawn P))
		StartFire (byte FireModeNum))
		StopFire (byte FireModeNum ))
		SwitchToBestWeapon (optional bool bForceADifferentWeapon ))

bMustHoldWeapon Source code

if true, don't allow player to put down weapon without switching to another one

InventoryChain Source code

First inventory item in inventory linked list

LastAttemptedSwitchToWeapon Source code

PendingFire Source code

Holds the current "Fire" status for both firing modes

PendingWeapon Source code

Player will switch to PendingWeapon, once the current weapon has been put down. @fixme laurent -- PendingWeapon should be made protected, because too many bugs result by setting this variable directly. It's only safe to read it, but to change it, SetCurrentWeapon() should be used.

AddInventory Source code

Adds an existing inventory item to the list. Returns true to indicate it was added, false if it was already in the list.
@param NewItem Item to add to inventory manager.
@return true if item was added, false otherwise.

CancelWeaponChange Source code

Prevents player from being without a weapon.

ChangedWeapon Source code

ChangedWeapon is called when the current weapon is finished being deactivated

ClientSyncWeapon Source code

If the server detects that the client's weapon is out of sync, it will use this function to realign them. Network: LocalPlayer @Param NewWeapon The weapon the server wishes to force the client to

ClientWeaponSet Source code

Weapon just given to a player, check if player should switch to this weapon Network: LocalPlayer Called from Weapon.ClientWeaponSet()

CreateInventory Source code

Spawns a new Inventory actor of NewInventoryItemClass type, and adds it to the Inventory Manager.
@param NewInventoryItemClass Class of inventory item to spawn and add.
@return Inventory actor, None if couldn't be spawned.

Destroyed Source code

Event called when inventory manager is destroyed, called from Pawn.Destroyed()

DiscardInventory Source code

Discard full inventory, generally because the owner died

DrawHud Source code

Hook called from HUD actor. Gives access to HUD and Canvas
@param H HUD

DumpWeaponStats Source code

Dump debug stats in log of all weapons in inventory.

FindInventoryType Source code

returns the inventory item of the requested class if it exists in this inventory manager.
@param DesiredClass class of inventory item we're trying to find.
@param bAllowSubclass whether subclasses of the desired class are acceptable
@return Inventory actor if found, None otherwise.

GetBestWeapon Source code

returns the best weapon for this Pawn in loadout

GetWeaponRatingFor Source code

Returns a weight reflecting the desire to use the given weapon, used for AI and player best weapon selection.
@param Weapon W
@return Weapon rating (range -1.f to 1.f)

HandlePickupQuery Source code

Handle Pickup. Can Pawn pickup this item?
@param ItemClass Class of Inventory our Owner is trying to pick up
@param Pickup the Actor containing that item (this may be a PickupFactory or it may be a DroppedPickup)
@return whether or not the Pickup actor should give its item to Other

InventoryActors Source code

returns all Inventory Actors of class BaseClass
@param BaseClass Inventory actors returned are of, or childs of, this base class.
@output Inv Inventory actors returned.
@note this iterator bails if it encounters more than 100 items, since temporary loops in linked list may sometimes be created on network clients while link pointers are being replicated. For performance reasons you shouldn't have that many inventory items anyway.

IsActiveWeapon Source code

returns true if ThisWeapon is the Pawn's active weapon.
@param ThisWeapon weapon to test if it's the Pawn's active weapon.
@return true if ThisWeapon is the Pawn's current weapon

ModifyDamage Source code

Damage modifier. Is Pawn carrying items that can modify taken damage? Called from GameInfo.ReduceDamage()

NextWeapon Source code

Switches to Next weapon Network: Client

OwnerEvent Source code

Used to inform inventory when owner event occurs (for example jumping or weapon change)
@param EventName Name of event to forward to inventory items.

PostBeginPlay Source code

PrevWeapon Source code

Switches to Previous weapon Network: Client

RemoveFromInventory Source code

Attempts to remove an item from the inventory list if it exists.
@param Item Item to remove from inventory

ServerSetCurrentWeapon Source code

ServerSetCurrentWeapon begins the Putdown sequence on the server. This function makes the assumption that if TryPutDown succeeded on the client, it will succeed on the server. This function shouldn't be called from anywhere except SetCurrentWeapon Network: Dedicated Server

SetCurrentWeapon Source code

Set DesiredWeapon as Current (Active) Weapon. Network: LocalPlayer
@param DesiredWeapon, Desired weapon to assign to player

SetPendingWeapon Source code

Set the pending weapon for switching. This shouldn't be called outside of SetCurrentWeapon()

SetupFor Source code

Setup Inventory for Pawn P. Override this to change inventory assignment (from a pawn to another) Network: Server only

StartFire Source code

Pawn desires to fire. By default it fires the Active Weapon if it exists. Called from PlayerController::StartFire() -> Pawn::StartFire() Network: Local Player
@param FireModeNum Fire mode number.

StopFire Source code

Pawn stops firing. i.e. player releases fire button, this may not stop weapon firing right away. (for example press button once for a burst fire) Network: Local Player
@param FireModeNum Fire mode number.

SwitchToBestWeapon Source code

Switch to best weapon available in loadout Network: LocalPlayer

defaultproperties
{
   RemoteRole=ROLE_SimulatedProxy
   TickGroup=TG_DuringAsyncWork
   bHidden=True
   bOnlyRelevantToOwner=True
   bReplicateInstigator=True
   bReplicateMovement=False
   bOnlyDirtyReplication=True
   NetPriority=1.400000
   CollisionType=COLLIDE_CustomDefault
   Name="Default__InventoryManager"
   ObjectArchetype=Actor'Engine.Default__Actor'
}