Always snap to grid

UE2:Pickup (U2XMP)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 09:10, 17 May 2008 by Wormbo (Talk | contribs) (Auto-generated page)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
U2XMP Object >> Actor >> Pickup
Package: 
Engine
Direct subclasses:
AmmoPack, Ammo, ArmorPickup, ArtifactPickup, PowerSuitPickup, PowerUpPickup, U2FlashLight, WeaponPickup
This class in other games:
RTNP, U1, UT, UE2Runtime, UT2003, U2, UT2004

Pickup items.

Pickup is the base class of actors that when touched by an appropriate pawn, will create and place an Inventory actor in that pawn's inventory chain. Each pickup class has an associated inventory class (its InventoryType). Pickups are placed by level designers. Pickups can only interact with pawns when in their default Pickup state. Pickups verify that they can give inventory to a pawn by calling the GameInfo's PickupQuery() function. After a pickup spawns an inventory item for a pawn, it then queries the GameInfo by calling the GameInfo's ShouldRespawn() function about whether it should remain active, enter its Sleep state and later become active again, or destroy itself.

When navigation paths are built, each pickup has an InventorySpot (a subclass of NavigationPoint) placed on it and associated with it (the Pickup's MyMarker== the InventorySpot, and the InventorySpot's markedItem == the pickup).

Constants[edit]

StopFallingTimer[edit]

Value: 'StopFalling'


Properties[edit]

Property group 'Display'[edit]

bAmbientGlow[edit]

Type: bool

Whether to glow or not.

Property group 'Pickup'[edit]

bPlayerOnly[edit]

Type: bool


InventoryType[edit]

Type: class<Inventory>


MaxDesireability[edit]

Type: float

Maximum desireability this item will ever have.

Default value: 0.0050

PickupMessage[edit]

Type: string

Modifiers: localized

Human readable description when picked up.

Default value: "Snagged an item."

PickupSound[edit]

Type: Sound


RespawnTime[edit]

Type: float

Respawn after this time, 0 for instant.

Internal variables[edit]

bOnlyReplicateHidden[edit]

Type: bool

only replicate changes in bHidden (optimization for level pickups)

Default value: True

FallingTimeoutDelay[edit]

Type: float

NEW(mib) check for pickups stuck in PHYS_Falling

MyMarker[edit]

Type: InventorySpot


Default values[edit]

Property Value
bAlwaysRelevant True
bCollideActors True
bCollideWorld True
bFixedRotationDir True
bIgnoreSingularityDamage False
bIgnoreSingularityForces False
bOrientOnSlope True
DesiredRotation
Member Value
Yaw 30000
DrawType DT_Mesh
NetPriority 1.4
NetUpdateFrequency 8.0
Physics PHYS_Falling
RemoteRole ROLE_SimulatedProxy
Texture Texture'Engine.S_Inventory'

Functions[edit]

Static functions[edit]

GetLocalString[edit]

static function string GetLocalString (optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2)

Overrides: Actor.GetLocalString


Events[edit]

Destroyed[edit]

event Destroyed ()

Overrides: Actor.Destroyed


Landed[edit]

event Landed (Object.Vector HitNormal)

Overrides: Actor.Landed


PostBeginPlay[edit]

event PostBeginPlay ()

Overrides: Actor.PostBeginPlay


Replication[edit]

event Replication ()

Overrides: Actor.Replication


Other instance functions[edit]

AnnouncePickup[edit]

function AnnouncePickup (Pawn Receiver)


BotDesireability[edit]

function float BotDesireability (Pawn Bot)


InitDroppedPickupFor[edit]

function InitDroppedPickupFor (Inventory Inv)


MaybeAddMoreAmmo[edit]

function bool MaybeAddMoreAmmo (Weapon W, Pawn Other)


PostRecvVelocity[edit]

simulated function PostRecvVelocity ()


ReadyToPickup[edit]

function bool ReadyToPickup (float MaxWait)


Reset[edit]

function Reset ()

Overrides: Actor.Reset


SetRespawn[edit]

function SetRespawn ()


SpawnCopy[edit]

function Inventory SpawnCopy (Pawn Other)


StartSleeping[edit]

function StartSleeping ()


StopFalling[edit]

function StopFalling ()


States[edit]

Pickup[edit]

Modifiers: auto

Pickup.BeginState[edit]

event BeginState ()

Overrides: Object.BeginState (global)


Pickup.Timer[edit]

event Timer ()

Overrides: Actor.Timer (global)


Pickup.Touch[edit]

event Touch (Actor Other)

Overrides: Actor.Touch (global)


Pickup.BotDesireability[edit]

function float BotDesireability (Pawn Bot)

Overrides: BotDesireability (global)


Pickup.CheckTouching[edit]

function CheckTouching ()


Pickup.ReadyToPickup[edit]

function bool ReadyToPickup (float MaxWait)

Overrides: ReadyToPickup (global)


Pickup.ValidTouch[edit]

function bool ValidTouch (Actor Other)


Sleeping[edit]

Ignores: Touch

Sleeping.BeginState[edit]

event BeginState ()

Overrides: Object.BeginState (global)


Sleeping.EndState[edit]

event EndState ()

Overrides: Object.EndState (global)


Sleeping.ReadyToPickup[edit]

function bool ReadyToPickup (float MaxWait)

Overrides: ReadyToPickup (global)


Sleeping.StartSleeping[edit]

function StartSleeping ()

Overrides: StartSleeping (global)