I love the smell of UnrealEd crashing in the morning. – tarquin

UE2:Inventory (U2)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
U2 Object >> Actor >> Inventory
Package: 
Engine
Direct subclasses:
Artifact, PowerUp, Powerups, Weapon
This class in other games:
RTNP, U1, UT, U2XMP, UE2Runtime, UT2003, UT2004, UDK, UT3

Inventory

Inventory is the parent class of all actors that can be carried by other actors. Inventory items are placed in the holding actor's inventory chain, a linked list of inventory actors. Each inventory class knows what pickup can spawn it (its PickupClass). When tossed out (using the DropFrom() function), inventory items replace themselves with an actor of their Pickup class.

Properties[edit]

Property group 'FirstPerson'[edit]

PlayerViewOffset[edit]

Type: Object.Vector

Offset from view center.

PlayerViewPivot[edit]

Type: Object.Rotator

additive rotation offset for tweaks

Property group 'Inventory'[edit]

bDrawingFirstPerson[edit]

Type: bool


Charge[edit]

Type: int

Modifiers: travel

Charge (for example, armor remaining if an armor)

Internal variables[edit]

AttachmentClass[edit]

Type: class<InventoryAttachment>


Default value: Class'Engine.InventoryAttachment'

bDisplayableInv[edit]

Type: bool

Item displayed in HUD.

bMergesCopies[edit]

Type: bool


BobDamping[edit]

Type: float


Default value: 0.7

bTossedOut[edit]

Type: bool

true if weapon/inventory was tossed out (so players can't cheat w/ weaponstay)

GroupOffset[edit]

Type: byte

position within inventory group. (used by prevweapon and nextweapon)

Icon[edit]

Type: Material


IconIndex[edit]

Type: int


InventoryGroup[edit]

Type: byte

The weapon/inventory set, 0-9.

ItemID[edit]

Type: string

Two character abbreviation for this item.

ItemName[edit]

Type: string

Modifiers: localized


PickupClass[edit]

Type: class<Pickup>

what class of pickup is associated with this inventory item

StatusIcon[edit]

Type: Material

Icon used with ammo/charge/power count on HUD.

ThirdPersonActor[edit]

Type: Actor


Default values[edit]

Property Value
bClientAnim True
bHidden True
bOnlyDirtyReplication True
bOnlyOwnerSee True
bOnlyRelevantToOwner True
bReplicateMovement False
bTravel True
DrawType DT_None
NetPriority 1.4
RemoteRole ROLE_SimulatedProxy

Functions[edit]

Static functions[edit]

StaticItemName[edit]

static function string StaticItemName ()


Exec functions[edit]

updaterelative[edit]

exec function updaterelative (int pitch, int yaw, int roll)


Events[edit]

Destroyed[edit]

event Destroyed ()

Overrides: Actor.Destroyed


RenderOverlays[edit]

simulated event RenderOverlays (Canvas Canvas)

Overrides: Actor.RenderOverlays


TravelPostAccept[edit]

event TravelPostAccept ()

Overrides: Actor.TravelPostAccept


TravelPreAccept[edit]

event TravelPreAccept ()

Overrides: Actor.TravelPreAccept


Other instance functions[edit]

AttachToPawn[edit]

function AttachToPawn (Pawn P)


ClientAddInventory[edit]

function ClientAddInventory (Pawn Other)


ClientDeleteInventory[edit]

function ClientDeleteInventory (Pawn Other)


DetachFromPawn[edit]

function DetachFromPawn (Pawn P)


DropFrom[edit]

function Pickup DropFrom (Object.Vector StartLocation)


Dump[edit]

function Dump (coerce string PrependStr, coerce string AppendStr)


GetHumanReadableName[edit]

simulated function string GetHumanReadableName ()

Overrides: Actor.GetHumanReadableName


GiveTo[edit]

function GiveTo (Pawn Other)


HandlePickupQuery[edit]

function bool HandlePickupQuery (Pickup Item)


NextWeapon[edit]

simulated function Weapon NextWeapon (Weapon CurrentChoice, Weapon CurrentWeapon)


NotifyAddInventory[edit]

function NotifyAddInventory (Pawn Other)


NotifyDeleteInventory[edit]

function NotifyDeleteInventory (Pawn Other)


OwnerEvent[edit]

function OwnerEvent (name EventName)


PickupFunction[edit]

function PickupFunction (Pawn Other)


PrevWeapon[edit]

simulated function Weapon PrevWeapon (Weapon CurrentChoice, Weapon CurrentWeapon)


PrioritizeArmor[edit]

function Armor PrioritizeArmor (int Damage, class<DamageTypeDamageType, Object.Vector HitLocation)


RecommendWeapon[edit]

simulated function Weapon RecommendWeapon (out float rating)


Resupply[edit]

function Resupply (float PercentAdded)


SelectNext[edit]

function Powerups SelectNext ()


SetOwnerDisplay[edit]

function SetOwnerDisplay ()


TransferSpecialProperties[edit]

function TransferSpecialProperties ()


Use[edit]

function Use (float Value)


WeaponChange[edit]

simulated function Weapon WeaponChange (byte F, Weapon CurrentChoice)