I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

UE2:Pickup (UT2003)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT2003 Object >> Actor >> Pickup

Contents

Package: 
Engine
Direct subclasses:
Ammo, ArmorPickup, KeyPickup, TournamentPickup, WeaponPickup
This class in other games:
RTNP, U1, U2, U2XMP, UE2Runtime, UT, 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).

[edit] Properties

[edit] Property group 'Display'

[edit] bAmbientGlow

Type: bool

Whether to glow or not.

[edit] Property group 'Pickup'

[edit] bInstantRespawn

Type: bool

Can be tagged so this item respawns instantly.

[edit] InventoryType

Type: class<Inventory>


[edit] PickUpBase

Type: xPickUpBase

Pick-up base which spawned this pickup.

[edit] PickupForce

Type: string

jdf

[edit] PickupMessage

Type: string

Modifiers: localized

Human readable description when picked up.

Default value: "Snagged an item."

[edit] PickupSound

Type: Sound


[edit] RespawnTime

Type: float

Respawn after this time, 0 for instant.

[edit] Internal variables

[edit] bDropped

Type: bool


[edit] bOnlyReplicateHidden

Type: bool

only replicate changes in bHidden (optimization for level pickups)

Default value: True

[edit] bPredictRespawns

Type: bool

high skill bots may predict respawns for this item

[edit] MaxDesireability

Type: float

Maximum desireability this item will ever have.

Default value: 0.1

[edit] MyMarker

Type: InventorySpot


[edit] PickupCache

Type: NavigationPoint

used for dropped pickups

[edit] RespawnEffectTime

Type: float


Default value: 0.5

[edit] Default values

Property Value
bAlwaysRelevant True
bCollideActors True
bCollideWorld True
bFixedRotationDir True
bIgnoreEncroachers True
bOnlyDirtyReplication True
bOrientOnSlope True
bShouldBaseAtStartup True
bUseCylinderCollision True
DesiredRotation
Member Value
Yaw 30000
DrawType DT_Mesh
NetPriority 1.4
NetUpdateFrequency 8.0
RotationRate
Member Value
Yaw 5000
Texture Texture'Engine.S_Inventory'

[edit] Functions

[edit] Static functions

[edit] GetLocalString

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

Overrides: Actor.GetLocalString


[edit] StaticPrecache

static function StaticPrecache (LevelInfo L)


[edit] Native functions

[edit] AddToNavigation

native final function AddToNavigation ()


[edit] RemoveFromNavigation

native final function RemoveFromNavigation ()


[edit] Events

[edit] Destroyed

event Destroyed ()

Overrides: Actor.Destroyed


[edit] Landed

event Landed (Object.Vector HitNormal)

Overrides: Actor.Landed


[edit] Other instance functions

[edit] AnnouncePickup

function AnnouncePickup (Pawn Receiver)


[edit] BotDesireability

function float BotDesireability (Pawn Bot)


[edit] DetourWeight

function float DetourWeight (Pawn Other, float PathWeight)


[edit] GetRespawnTime

function float GetRespawnTime ()


[edit] InitDroppedPickupFor

function InitDroppedPickupFor (Inventory Inv)


[edit] ReadyToPickup

function bool ReadyToPickup (float MaxWait)


[edit] Reset

function Reset ()

Overrides: Actor.Reset


[edit] RespawnEffect

function RespawnEffect ()


[edit] SetRespawn

function SetRespawn ()


[edit] SpawnCopy

function Inventory SpawnCopy (Pawn Other)


[edit] StartSleeping

function StartSleeping ()


[edit] Transmogrify

function Pickup Transmogrify (class<PickupNewClass)


[edit] States

[edit] FadeOut

Extends: Pickup

[edit] FadeOut.BeginState

event BeginState ()

Overrides: Pickup.BeginState


[edit] FadeOut.EndState

event EndState ()

Overrides: Pickup.EndState


[edit] FadeOut.Tick

event Tick (float DeltaTime)

Overrides: Actor.Tick (global)


[edit] FallingPickup

Extends: Pickup

[edit] FallingPickup.BeginState

event BeginState ()

Overrides: Pickup.BeginState


[edit] FallingPickup.Timer

event Timer ()

Overrides: Pickup.Timer


[edit] FallingPickup.CheckTouching

function CheckTouching ()

Overrides: Pickup.CheckTouching


[edit] Pickup

Modifiers: auto

[edit] Pickup.BeginState

event BeginState ()

Overrides: Object.BeginState (global)


[edit] Pickup.EndState

event EndState ()

Overrides: Object.EndState (global)


[edit] Pickup.Timer

event Timer ()

Overrides: Actor.Timer (global)


[edit] Pickup.Touch

event Touch (Actor Other)

Overrides: Actor.Touch (global)


[edit] Pickup.CheckTouching

function CheckTouching ()


[edit] Pickup.ReadyToPickup

function bool ReadyToPickup (float MaxWait)

Overrides: ReadyToPickup (global)


[edit] Pickup.ValidTouch

function bool ValidTouch (Actor Other)


[edit] Sleeping

Ignores: Touch

[edit] Sleeping.BeginState

event BeginState ()

Overrides: Object.BeginState (global)


[edit] Sleeping.EndState

event EndState ()

Overrides: Object.EndState (global)


[edit] Sleeping.ReadyToPickup

function bool ReadyToPickup (float MaxWait)

Overrides: ReadyToPickup (global)


[edit] Sleeping.StartSleeping

function StartSleeping ()

Overrides: StartSleeping (global)


Personal tools