The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

Difference between revisions of "UE3:UTWeaponPickupFactory (UT3)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Auto-generated page)
 
m (added missing members)
 
(One intermediate revision by one other user not shown)
Line 8: Line 8:
 
}}
 
}}
 
{{autogenerated}}
 
{{autogenerated}}
−
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.
+
Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.
  
 
==Properties==
 
==Properties==
Line 24: Line 24:
  
 
'''Default value:''' {{cl|ParticleSystemComponent}}'{{tl|GlowEffect}}'
 
'''Default value:''' {{cl|ParticleSystemComponent}}'{{tl|GlowEffect}}'
 +
 +
====bIsActive====
 +
'''Type:''' [[bool]]
 +
 +
clientside flag - whether the locker should be displayed as active and having weapons available
 +
 +
====bVerifiedWeaponStay====
 +
'''Type:''' [[bool]]
 +
 +
<!-- enter variable description -->
  
 
====bWeaponStay====
 
====bWeaponStay====
Line 31: Line 41:
  
 
'''Default value:''' True
 
'''Default value:''' True
 +
 +
====Customers====
 +
'''Type:''' [[array]]<{{tl|PawnToucher|UTWeaponLocker}}>
 +
 +
<!-- enter variable description -->
  
 
====WeaponPickupScaling====
 
====WeaponPickupScaling====
Line 37: Line 52:
 
Used to scale weapon pickup drawscale
 
Used to scale weapon pickup drawscale
  
−
'''Default value:''' 1.0
+
'''Default value:''' 1.2
  
 
===Default values===
 
===Default values===
Line 82: Line 97:
 
! Value
 
! Value
 
|-
 
|-
−
| 000000,Y
+
| X
−
|  
+
| 0.0
 
|-
 
|-
−
| 000000,Z
+
| Y
−
|  
+
| 0.0
 
|-
 
|-
−
| X
+
| Z
−
| 0.0
+
| -44.0
 
|}
 
|}
 
|}
 
|}
Line 124: Line 139:
 
! {{tl|Vector||Object structs|Member}}
 
! {{tl|Vector||Object structs|Member}}
 
! Value
 
! Value
−
|-
 
−
| 000000,Y
 
−
|
 
−
|-
 
−
| 000000,Z
 
−
|
 
 
|-
 
|-
 
| X
 
| X
 
| 0.0
 
| 0.0
 +
|-
 +
| Y
 +
| 0.0
 +
|-
 +
| Z
 +
| -44.0
 
|}
 
|}
 
|}
 
|}
Line 160: Line 175:
  
 
===Other instance functions===
 
===Other instance functions===
 +
====AddCustomer====
 +
{{code|function [[bool]]&nbsp;'''AddCustomer''' ({{cl|Pawn}}&nbsp;'''P''')}}
 +
 +
<!-- enter function description -->
 +
 +
====AllowPickup====
 +
{{code|function [[bool]]&nbsp;'''AllowPickup''' ({{cl|UTBot}}&nbsp;'''Bot''')}}
 +
 +
<!-- enter function description -->
 +
 
====AllowRepeatPickup====
 
====AllowRepeatPickup====
 
{{code|function [[bool]]&nbsp;'''AllowRepeatPickup''' ()}}
 
{{code|function [[bool]]&nbsp;'''AllowRepeatPickup''' ()}}
Line 169: Line 194:
  
 
'''Overrides:''' {{tl|CheckForErrors|PickupFactory}}
 
'''Overrides:''' {{tl|CheckForErrors|PickupFactory}}
 +
 +
<!-- enter function description -->
 +
 +
====CheckWeaponStay====
 +
{{code|simulated function '''CheckWeaponStay''' ()}}
 +
 +
<!-- enter function description -->
 +
 +
====HasCustomer====
 +
{{code|function [[bool]]&nbsp;'''HasCustomer''' ({{cl|Pawn}}&nbsp;'''P''')}}
  
 
<!-- enter function description -->
 
<!-- enter function description -->
Line 176: Line 211:
  
 
'''Overrides:''' {{tl|InitializePickup|PickupFactory}}
 
'''Overrides:''' {{tl|InitializePickup|PickupFactory}}
 +
 +
<!-- enter function description -->
 +
 +
====NotifyLocalPlayerDead====
 +
{{code|simulated function '''NotifyLocalPlayerDead''' ({{cl|PlayerController}}&nbsp;'''PC''')}}
  
 
<!-- enter function description -->
 
<!-- enter function description -->
Line 217: Line 257:
  
 
If our charge is not a super weapon and weaponstay is on, set weapon stay
 
If our charge is not a super weapon and weaponstay is on, set weapon stay
 +
 +
====ShowActive====
 +
{{code|simulated function '''ShowActive''' ()}}
 +
 +
<!-- enter function description -->
 +
 +
====ShowHidden====
 +
{{code|simulated function '''ShowHidden''' ()}}
 +
 +
<!-- enter function description -->
  
 
====SpawnCopyFor====
 
====SpawnCopyFor====
Line 229: Line 279:
  
 
'''Overrides:''' {{tl|StartSleeping|PickupFactory}}
 
'''Overrides:''' {{tl|StartSleeping|PickupFactory}}
 +
 +
<!-- enter function description -->
 +
 +
==States==
 +
===Pickup===
 +
<!-- enter state description -->
 +
 +
'''Inherits from:''' {{tl|Pickup|UTPickupFactory}}
 +
 +
'''[[States#Modifiers|Modifiers]]:''' auto
 +
 +
====Pickup.BeginState====
 +
{{code|simulated event '''BeginState''' ([[name]]&nbsp;'''PreviousStateName''')}}
 +
 +
'''Overrides:''' {{tl|Pickup.BeginState|UTPickupFactory}}
 +
 +
Called immediately when entering a state, while within the
 +
GotoState() call that caused the state change (before any
 +
state code is executed).
 +
 +
====Pickup.Touch====
 +
{{code|simulated event '''Touch''' ({{cl|Actor}}&nbsp;'''Other''', {{cl|PrimitiveComponent}}&nbsp;'''OtherComp''', {{tl|Vector|Object|structs}}&nbsp;'''HitLocation''', {{tl|Vector|Object|structs}}&nbsp;'''HitNormal''')}}
 +
 +
'''Overrides:''' {{tl|Pickup.Touch|PickupFactory}}
 +
 +
<!-- enter event description -->
 +
 +
====Pickup.AllowPickup====
 +
{{code|function [[bool]]&nbsp;'''AllowPickup''' ({{cl|UTBot}}&nbsp;'''Bot''')}}
 +
 +
'''Overrides:''' {{tl|AllowPickup}} ''(global)''
 +
 +
<!-- enter function description -->
 +
 +
====Pickup.NotifyLocalPlayerDead====
 +
{{code|simulated function '''NotifyLocalPlayerDead''' ({{cl|PlayerController}}&nbsp;'''PC''')}}
 +
 +
'''Overrides:''' {{tl|NotifyLocalPlayerDead}} ''(global)''
 +
 +
<!-- enter function description -->
 +
 +
====Pickup.ShowActive====
 +
{{code|simulated function '''ShowActive''' ()}}
 +
 +
'''Overrides:''' {{tl|ShowActive}} ''(global)''
 +
 +
<!-- enter function description -->
 +
 +
====Pickup.ValidTouch====
 +
{{code|simulated function [[bool]]&nbsp;'''ValidTouch''' ({{cl|Pawn}}&nbsp;'''Other''')}}
 +
 +
'''Overrides:''' {{tl|Pickup.ValidTouch|PickupFactory}}
  
 
<!-- enter function description -->
 
<!-- enter function description -->

Latest revision as of 07:32, 16 August 2009

UT3 Object >> Actor >> NavigationPoint >> PickupFactory >> UTPickupFactory >> UTWeaponPickupFactory
Package: 
UTGame
This class in other games:
UDK
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Properties[edit]

Property group 'UTWeaponPickupFactory'[edit]

WeaponPickupClass[edit]

Type: class<UTWeapon>


Internal variables[edit]

BaseGlow[edit]

Type: ParticleSystemComponent

The glow that emits from the base while the weapon is available

Default value: ParticleSystemComponent'GlowEffect'

bIsActive[edit]

Type: bool

clientside flag - whether the locker should be displayed as active and having weapons available

bVerifiedWeaponStay[edit]

Type: bool


bWeaponStay[edit]

Type: bool


Default value: True

Customers[edit]

Type: array<UTWeaponLocker.PawnToucher>


WeaponPickupScaling[edit]

Type: float

Used to scale weapon pickup drawscale

Default value: 1.2

Default values[edit]

Property Value
bBlockActors True
bDoVisibilityFadeIn False
bRotatingPickup True
CollisionType COLLIDE_CustomDefault
Components[4] ParticleSystemComponent'GlowEffect'
RespawnSound SoundCue'A_Pickups.Weapons.Cue.A_Pickup_Weapons_Respawn_Cue'

Subobjects[edit]

BaseMeshComp[edit]

Class: Engine.StaticMeshComponent

Inherits from: UTPickupFactory.BaseMeshComp

Property Value
StaticMesh StaticMesh'PICKUPS.WeaponBase.S_Pickups_WeaponBase'
Translation
Member Value
X 0.0
Y 0.0
Z -44.0

CollisionCylinder[edit]

Class: Engine.CylinderComponent

Inherits from: UTPickupFactory.CollisionCylinder

Property Value
BlockZeroExtent False

GlowEffect[edit]

Class: Engine.ParticleSystemComponent

Property Value
SecondsBeforeInactive 1.0
Template ParticleSystem'PICKUPS.WeaponBase.Effects.P_Pickups_WeaponBase_Glow'
Translation
Member Value
X 0.0
Y 0.0
Z -44.0

PathRenderer[edit]

Class: Engine.PathRenderingComponent

Inherits from: UTPickupFactory.PathRenderer

No new values.

PickupLightEnvironment[edit]

Class: Engine.DynamicLightEnvironmentComponent

Inherits from: UTPickupFactory.PickupLightEnvironment

No new values.

Functions[edit]

Events[edit]

ReplicatedEvent[edit]

simulated event ReplicatedEvent (name VarName)

Overrides: UTPickupFactory.ReplicatedEvent

Look for changes in bPulseBase or bPickupHidden and set the TargetEmissive accordingly

Other instance functions[edit]

AddCustomer[edit]

function bool AddCustomer (Pawn P)


AllowPickup[edit]

function bool AllowPickup (UTBot Bot)


AllowRepeatPickup[edit]

function bool AllowRepeatPickup ()


CheckForErrors[edit]

function bool CheckForErrors ()

Overrides: PickupFactory.CheckForErrors


CheckWeaponStay[edit]

simulated function CheckWeaponStay ()


HasCustomer[edit]

function bool HasCustomer (Pawn P)


InitializePickup[edit]

simulated function InitializePickup ()

Overrides: PickupFactory.InitializePickup


NotifyLocalPlayerDead[edit]

simulated function NotifyLocalPlayerDead (PlayerController PC)


PickedUpBy[edit]

function PickedUpBy (Pawn P)

Overrides: UTPickupFactory.PickedUpBy

(Description copied from Actor.PickedUpBy)
implemented by pickup type Actors to do things following a successful pickup

Parameters:

  • P - the Pawn that picked us up

Todo: remove this and fix up the DenyPickupQuery() calls that use this

SetPickupHidden[edit]

simulated function SetPickupHidden ()

Overrides: UTPickupFactory.SetPickupHidden


SetPickupMesh[edit]

simulated function SetPickupMesh ()

Overrides: UTPickupFactory.SetPickupMesh


SetPickupVisible[edit]

simulated function SetPickupVisible ()

Overrides: UTPickupFactory.SetPickupVisible


SetWeaponStay[edit]

function SetWeaponStay ()

If our charge is not a super weapon and weaponstay is on, set weapon stay

ShowActive[edit]

simulated function ShowActive ()


ShowHidden[edit]

simulated function ShowHidden ()


SpawnCopyFor[edit]

function SpawnCopyFor (Pawn Recipient)

Overrides: PickupFactory.SpawnCopyFor


StartSleeping[edit]

function StartSleeping ()

Overrides: PickupFactory.StartSleeping


States[edit]

Pickup[edit]

Inherits from: UTPickupFactory.Pickup

Modifiers: auto

Pickup.BeginState[edit]

simulated event BeginState (name PreviousStateName)

Overrides: UTPickupFactory.Pickup.BeginState

Called immediately when entering a state, while within the GotoState() call that caused the state change (before any state code is executed).

Pickup.Touch[edit]

simulated event Touch (Actor Other, PrimitiveComponent OtherComp, Object.Vector HitLocation, Object.Vector HitNormal)

Overrides: PickupFactory.Pickup.Touch


Pickup.AllowPickup[edit]

function bool AllowPickup (UTBot Bot)

Overrides: AllowPickup (global)


Pickup.NotifyLocalPlayerDead[edit]

simulated function NotifyLocalPlayerDead (PlayerController PC)

Overrides: NotifyLocalPlayerDead (global)


Pickup.ShowActive[edit]

simulated function ShowActive ()

Overrides: ShowActive (global)


Pickup.ValidTouch[edit]

simulated function bool ValidTouch (Pawn Other)

Overrides: PickupFactory.Pickup.ValidTouch


Retrieved from "https://wiki.beyondunreal.com/UE3:UTWeaponPickupFactory_(UT3)?oldid=35336"