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

Difference between revisions of "UE3:UTVWeap SPMACannon (UT3)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Auto-generated page)
 
m (added missing members)
 
Line 11: Line 11:
 
}}
 
}}
 
{{autogenerated}}
 
{{autogenerated}}
−
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.
+
Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.
  
 
==Properties==
 
==Properties==
Line 38: Line 38:
  
 
<!-- enter variable description -->
 
<!-- enter variable description -->
 +
 +
====ReadyToFireSound====
 +
'''Type:''' {{cl|SoundCue}}
 +
 +
<!-- enter variable description -->
 +
 +
'''Default value:''' {{cl|SoundCue}}'A_Weapon_RocketLauncher.Cue.A_Weapon_RL_SeekLock_Cue'
  
 
====RemoteCamera====
 
====RemoteCamera====
Line 48: Line 55:
  
 
<!-- enter variable description -->
 
<!-- enter variable description -->
 +
 +
===Default values===
 +
{| class="list defaults"
 +
! Property
 +
! Value
 +
|-
 +
| {{tl|AmmoDisplayType||UTWeapon internal variables}}
 +
| {{tl|AmmoWidgetDisplayStyle||UTWeapon|EAWDS_BarGraph}}
 +
|}
  
 
===Subobjects===
 
===Subobjects===
Line 76: Line 92:
  
 
<!-- enter event description -->
 
<!-- enter event description -->
 +
 +
====GetPowerPerc====
 +
{{code|simulated event [[float]]&nbsp;'''GetPowerPerc''' ()}}
 +
 +
'''Overrides:''' {{tl|GetPowerPerc|UTWeapon}}
 +
 +
''(Description copied from {{tl|GetPowerPerc|UTWeapon}})''<br/>
 +
This function is meant to be overridden in children.  It turns the current power percentage for
 +
a weapon.  It's called mostly from the hud
 +
 +
'''Returns:'''
 +
:the percentage of power ( 1.0 - 0.0 )
  
 
====IsAimCorrect====
 
====IsAimCorrect====
Line 86: Line 114:
 
'''Returns:'''
 
'''Returns:'''
 
:TRUE if we can hit where the controller is aiming
 
:TRUE if we can hit where the controller is aiming
 +
 +
====PostBeginPlay====
 +
{{code|simulated event '''PostBeginPlay''' ()}}
 +
 +
'''Overrides:''' {{tl|PostBeginPlay|UTVehicleWeapon}}
 +
 +
Initialize the weapon
  
 
===Other instance functions===
 
===Other instance functions===
Line 93: Line 128:
 
'''Overrides:''' {{tl|BeginFire|UTVehicleWeapon}}
 
'''Overrides:''' {{tl|BeginFire|UTVehicleWeapon}}
  
−
BeginFire is the point at which the server and client sync up their code path.  It's job is to set
+
Override BeginFire and restrict firing when the vehicle isn't deployed
−
the weapon in to the firing state.
+
 
−
Network: LocalPlayer and Server
+
'''Parameters:'''
 +
* ''FireModeNum'' - 0 = Fire | 1 = AltFire
  
 
====BestMode====
 
====BestMode====
Line 160: Line 196:
  
 
In the case of Alt-Fire, handle the camera
 
In the case of Alt-Fire, handle the camera
 +
 +
====RangedAttackTime====
 +
{{code|function [[float]]&nbsp;'''RangedAttackTime''' ()}}
 +
 +
'''Overrides:''' {{tl|RangedAttackTime|Weapon|instance functions}}
 +
 +
<!-- enter function description -->
 +
 +
====RecommendLongRangedAttack====
 +
{{code|function [[bool]]&nbsp;'''RecommendLongRangedAttack''' ()}}
 +
 +
'''Overrides:''' {{tl|RecommendLongRangedAttack|Weapon|instance functions}}
 +
 +
<!-- enter function description -->
 +
 +
==States==
 +
===WeaponFiring===
 +
<!-- enter state description -->
 +
 +
'''Inherits from:''' {{tl|WeaponFiring|UTWeapon}}
 +
 +
'''[[States#Modifiers|Modifiers]]:''' simulated
 +
 +
====WeaponFiring.RefireCheckTimer====
 +
{{code|simulated event '''RefireCheckTimer''' ()}}
 +
 +
'''Overrides:''' {{tl|WeaponFiring.RefireCheckTimer|Weapon}}
 +
 +
Play sound effect when weapon is ready to fire

Latest revision as of 07:21, 16 August 2009

UT3 Object >> Actor >> Inventory >> Weapon >> GameWeapon >> UTWeapon >> UTVehicleWeapon >> UTVWeap_SPMACannon
Package: 
UTGame
Direct subclass:
UTVWeap_SPMACannon_Content
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]

bCanHitTargetVector[edit]

Type: bool


BoomSound[edit]

Type: SoundCue


IncomingSound[edit]

Type: SoundCue


IncomingTargetLoc[edit]

Type: Object.Vector


LastCanAttackTime[edit]

Type: float


ReadyToFireSound[edit]

Type: SoundCue


Default value: SoundCue'A_Weapon_RocketLauncher.Cue.A_Weapon_RL_SeekLock_Cue'

RemoteCamera[edit]

Type: UTProj_SPMACamera

Holds a link to the remote camera

TargetVelocity[edit]

Type: Object.Vector


Default values[edit]

Property Value
AmmoDisplayType EAWDS_BarGraph

Subobjects[edit]

FirstPersonMesh[edit]

Class: UTGame.UTSkeletalMeshComponent

Inherits from: UTVehicleWeapon.FirstPersonMesh

No new values.

PickupMesh[edit]

Class: Engine.SkeletalMeshComponent

Inherits from: UTVehicleWeapon.PickupMesh

No new values.

Functions[edit]

Events[edit]

CalcTargetVelocity[edit]

simulated event CalcTargetVelocity ()

Calculates the velocity needed to lob a SPMA shell to a destination. Returns true if the SPMA can hit the currently target vector

GetPhysFireStartLocation[edit]

simulated event Object.Vector GetPhysFireStartLocation ()


GetPowerPerc[edit]

simulated event float GetPowerPerc ()

Overrides: UTWeapon.GetPowerPerc

(Description copied from UTWeapon.GetPowerPerc)
This function is meant to be overridden in children. It turns the current power percentage for a weapon. It's called mostly from the hud

Returns:

the percentage of power ( 1.0 - 0.0 )

IsAimCorrect[edit]

simulated event bool IsAimCorrect ()

Overrides: UTVehicleWeapon.IsAimCorrect

IsAimCorrect - Returns true if the turret associated with a given seat is aiming correctly

Returns:

TRUE if we can hit where the controller is aiming

PostBeginPlay[edit]

simulated event PostBeginPlay ()

Overrides: UTVehicleWeapon.PostBeginPlay

Initialize the weapon

Other instance functions[edit]

BeginFire[edit]

simulated function BeginFire (byte FireModeNum)

Overrides: UTVehicleWeapon.BeginFire

Override BeginFire and restrict firing when the vehicle isn't deployed

Parameters:

  • FireModeNum - 0 = Fire | 1 = AltFire

BestMode[edit]

function byte BestMode ()

Overrides: UTWeapon.BestMode

BestMode() choose between regular or alt-fire

CanAttack[edit]

function bool CanAttack (Actor Other)

Overrides: UTWeapon.CanAttack

return false if out of range, can't see target, etc.

DisconnectCamera[edit]

function DisconnectCamera (UTProj_SPMACamera Camera)

Called by a SPMA camera projectile, this handles the disconnection in terms of the gun and the vehicle/pawn.

Parameters:

  • Camera - The remote camera to disconnect

DrawWeaponCrosshair[edit]

simulated function DrawWeaponCrosshair (HUD HUD)

Overrides: UTVehicleWeapon.DrawWeaponCrosshair

Draw the Crosshairs

EnableFriendlyWarningCrosshair[edit]

simulated function bool EnableFriendlyWarningCrosshair ()

Overrides: UTWeapon.EnableFriendlyWarningCrosshair

Don't show the 'friendly dont shoot' indicator when aiming to fire a camera.

GetProjectileClass[edit]

function class<Projectile> GetProjectileClass ()

Overrides: Weapon.GetProjectileClass

If we do not have a camera out, force a camera

HolderDied[edit]

function HolderDied ()

Overrides: Weapon.HolderDied

Pawn holding this weapon as active weapon just died.

PlayIncomingSound[edit]

function PlayIncomingSound ()


ProjectileFire[edit]

simulated function Projectile ProjectileFire ()

Overrides: UTVehicleWeapon.ProjectileFire

In the case of Alt-Fire, handle the camera

RangedAttackTime[edit]

function float RangedAttackTime ()

Overrides: Weapon.RangedAttackTime


RecommendLongRangedAttack[edit]

function bool RecommendLongRangedAttack ()

Overrides: Weapon.RecommendLongRangedAttack


States[edit]

WeaponFiring[edit]

Inherits from: UTWeapon.WeaponFiring

Modifiers: simulated

WeaponFiring.RefireCheckTimer[edit]

simulated event RefireCheckTimer ()

Overrides: Weapon.WeaponFiring.RefireCheckTimer

Play sound effect when weapon is ready to fire

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