Engine.Weapon

Extends

Inventory

Modifiers

native abstract config ( game )

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

Core.Object
|   
+-- Engine.Actor
   |   
   +-- Engine.Inventory
      |   
      +-- Engine.Weapon

Direct Known Subclasses:

GameWeapon

Functions Summary
		Activate ()))
		Activate ())) Active
		Activate ())) WeaponEquipping
	int	AddAmmo (int Amount)
	rotator	AddSpread (rotator BaseAim))
	float	AdjustFOVAngle (float FOVAngle))
		AttachWeaponTo (SkeletalMeshComponent MeshCpnt, optional Name SocketName)
		BeginFire (Byte FireModeNum))
		BeginFire (byte FireModeNum)) Active
		BeginState (Name PreviousStateName)) Active
		BeginState (Name PreviousStateName )) Inactive
		BeginState (Name PreviousStateName)) PendingClientWeaponSet
		BeginState (Name PreviousStateName)) WeaponEquipping
		BeginState (Name PreviousStateName )) WeaponFiring
		BeginState (Name PreviousStateName)) WeaponPuttingDown
	ImpactInfo	CalcWeaponFire (vector StartTrace, vector EndTrace, optional out array<ImpactInfo> ImpactList))
	bool	CanAttack (Actor Other))
	bool	CanThrow ()))
		ClearFlashCount ()))
		ClearFlashLocation ()))
		ClearPendingFire (int FireMode))
		ClientWeaponSet (bool bOptionalSet))
		ClientWeaponThrown ()))
		ConsumeAmmo (byte FireModeNum)
		CustomFire ()
		DemoBeginFire (byte FireModeNum))
		DemoEndFire (byte FireModeNum))
	bool	DenyClientWeaponSet ()))
	bool	DenyPickupQuery (class<Inventory> ItemClass, Actor Pickup))
		Destroyed ()))
		DetachWeapon ()
		DisplayDebug (HUD HUD, out float out_YL, out float out_YPos))
	bool	DoOverrideNextWeapon ()))
	bool	DoOverridePrevWeapon ()))
		DropFrom (vector StartLocation, vector StartVelocity))
		DumpWeaponDebugToLog ()))
		EndFire (byte FireModeNum))
		EndState (Name NextStateName)) PendingClientWeaponSet
		EndState (Name NextStateName)) WeaponEquipping
		EndState (Name NextStateName )) WeaponFiring
		EndState (Name NextStateName)) WeaponPuttingDown
		FireAmmunition ()))
		FireModeUpdated (byte FiringMode, bool bViaReplication)
	bool	FireOnRelease ()))
	bool	FocusOnLeader (bool bLeaderFiring))
		ForceEndFire ()))
	Rotator	GetAdjustedAim (vector StartFireLoc ))
	float	GetAIRating ()))
	float	GetDamageRadius ()))
	float	GetFireInterval (byte FireModeNum ))
	Vector	GetMuzzleLoc ()))
	vector	GetPhysicalFireStartLoc (optional vector AimDir))
	class<Projectile>	GetProjectileClass ()))
	Actor	GetTraceOwner ()))
	float	GetTraceRange ()))
		GetViewAxes (out vector XAxis, out vector YAxis, out vector ZAxis ))
	AnimNodeSequence	GetWeaponAnimNodeSeq ()))
		GetWeaponDebug (out Array DebugInfo ))
	float	GetWeaponRating ()))
		GivenTo (Pawn ThisPawn, optional bool bDoNotActivate))
	bool	HasAmmo (byte FireModeNum, optional int Amount ))
	bool	HasAnyAmmo ()))
		HolderDied ()))
		IncrementFlashCount ()))
		InstantFire ()))
	bool	IsActiveWeapon ()))
	bool	IsFiring ()))
	bool	IsFiring ())) WeaponFiring
		ItemRemovedFromInvManager ()))
	float	MaxRange ()))
	bool	PassThroughDamage (Actor HitActor))
	bool	PendingFire (int FireMode))
		PendingWeaponSetTimer ())) PendingClientWeaponSet
		PlayFireEffects (byte FireModeNum, optional vector HitLocation)
		PlayFiringSound ()
		PlayWeaponAnimation (Name Sequence, float fDesiredDuration, optional bool bLoop, optional SkeletalMeshComponent SkelMesh))
		ProcessInstantHit (byte FiringMode, ImpactInfo Impact ))
	Projectile	ProjectileFire ()))
		PutDownWeapon ()))
	float	RangedAttackTime ()))
	bool	ReadyToFire (bool bFinished)) Active
	bool	RecommendLongRangedAttack ()))
	bool	RecommendRangedAttack ()))
		RefireCheckTimer ()
		RefireCheckTimer ())) WeaponFiring
	float	RelativeStrengthVersus (Pawn P, float Dist))
		SendToFiringState (byte FireModeNum))
		ServerStartFire (byte FireModeNum))
		ServerStartFire (byte FireModeNum )) Inactive
		ServerStopFire (byte FireModeNum))
		ServerStopFire (byte FireModeNum )) Inactive
		SetCurrentFireMode (byte FiringModeNum))
		SetFlashLocation (vector HitLocation ))
		SetPendingFire (int FireMode))
	bool	ShouldRefire ()))
		StartFire (byte FireModeNum))
		StartFire (byte FireModeNum) Inactive
	bool	StillFiring (byte FireMode))
		StopFire (byte FireModeNum))
		StopFireEffects (byte FireModeNum)
		StopWeaponAnimation ()))
	float	SuggestAttackStyle ()))
	float	SuggestDefenseStyle ()))
		TimeWeaponEquipping ()))
		TimeWeaponFiring (byte FireModeNum ))
		TimeWeaponPutDown ()))
	bool	TryPutDown ()))
	bool	TryPutDown ())) Active
	bool	TryPutDown ())) Inactive
	bool	TryPutDown ())) WeaponPuttingDown
		WeaponCalcCamera (float fDeltaTime, out vector out_CamLoc, out rotator out_CamRot)
		WeaponEmpty ()
		WeaponEquipped ())) WeaponEquipping
		WeaponIsDown ())) WeaponPuttingDown
		WeaponLog (coerce String Msg, coerce String FuncStr ))
		WeaponPlaySound (SoundCue Sound, optional float NoiseLoudness ))

AIRating Source code

bCanThrow Source code

Can player toss his weapon out? Typically false for default inventory.

bInstantHit Source code

bMeleeWeapon Source code

bWeaponPutDown Source code

Set to put weapon down at the end of a state. Typically used to change weapons on state changes (weapon up, stopped firing...)

CachedMaxRange Source code

Cache MaxRange of weapon

CurrentFireMode Source code

Current FireMode

FiringStatesArray Source code

Array of firing states defining available firemodes

InstantHitDamageTypes Source code

DamageTypes for Instant Hit Weapons

Priority Source code

Configurable weapon priority. Ties (mod weapons) are broken by GroupWeight

ShouldFireOnRelease Source code

AI Hints

WeaponFireTypes Source code

Defines the type of fire (see Enum above) for each mode

WeaponProjectiles Source code

The Class of Projectile to spawn

Weapon

DefaultAnimSpeed Source code

When no duration is specified, speed to play anims.

EquipTime Source code

How long does it take to Equip this weapon

FireInterval Source code

Holds the amount of time a single shot takes

FireOffset Source code

Holds an offest for spawning protectile effects.

InstantHitDamage Source code

How much damage does a given instanthit shot do

InstantHitMomentum Source code

momentum transfer scaling for instant hit damage

Mesh Source code

Weapon Mesh

PutDownTime Source code

How long does it take to put this weapon down

Spread Source code

How much of a spread between shots

WeaponRange Source code

Range of Weapon, used for Traces (InstantFire, ProjectileFire, AdjustAim...)

EWeaponFireType Source code

This enum defines the firing type for the weapon. EWFT_InstantHit - The weapon traces a shot to determine a hit and immediately causes an effect EWFT_Projectile - The weapon spawns a new projectile pointed at the crosshair EWFT_Custom - Requires a custom fire sequence

Activate Source code

All inventory use the Activate() function when an item is selected for use. For weapons, this function starts the Equipping process. If the weapon is the inactive state, it will go to the 'WeaponEquipping' followed by 'Active' state, and ready to be fired.

Activate Active Source code

Activate() ignored since already active

Activate WeaponEquipping Source code

Activate() ignored since already becoming active

AddAmmo Source code

Add ammo to weapon
@param Amount to add.
@return Amount actually added. (In case magazine is already full and some ammo is left Subclass me to define ammo addition rules.

AddSpread Source code

Adds any fire spread offset to the passed in rotator
@param Aim the base aim direction
@return the adjusted aim direction

AdjustFOVAngle Source code

This function can be used by a weapon to override a playercontroller's FOVAngle. It should be overriden in a subclass.

AttachWeaponTo Source code

AttachWeaponTo is called when it's time to attach the weapon's mesh to a location. it should be subclassed.

BeginFire Source code

BeginFire is the point at which the server and client sync up their code path. It's job is to set the weapon in to the firing state. Network: LocalPlayer and Server

BeginFire Active Source code

Override BeginFire so that it will enter the firing state right away.

BeginState Active Source code

Initialize the weapon as being active and ready to go.

BeginState Inactive Source code

Clear out the PendingFires

BeginState PendingClientWeaponSet Source code

Event called when weapon enters this state

BeginState WeaponEquipping Source code

BeginState WeaponFiring Source code

BeginState WeaponPuttingDown Source code

Time the process and clear the Firing flags

CalcWeaponFire Source code

CalcWeaponFire: Simulate an instant hit shot. This doesn't deal any damage nor trigger any effect. It just simulates a shot and returns the hit information, to be post-processed later. ImpactList returns a list of ImpactInfo containing all listed impacts during the simulation. CalcWeaponFire however returns one impact (return variable) being the first geometry impact straight, with no direction change. If you were to do refraction, reflection, bullet penetration or something like that, this would return exactly when the crosshair sees: The first 'real geometry' impact, skipping invisible triggers and volumes.
@param StartTrace world location to start trace from
@param EndTrace world location to end trace at
@output ImpactList list of all impacts that occured during simulation
@return first 'real geometry' impact that occured.
@note if an impact didn't occur, and impact is still returned, with its HitLocation being the EndTrace value.

CanAttack Source code

CanThrow Source code

Returns true if this item can be thrown out.

ClearFlashCount Source code

Clear flashCount variable on Pawn. and call WeaponStoppedFiring event. Call this on the server and local player. Network: Server or Local Player

ClearFlashLocation Source code

Reset flash location variable. and call stop firing. Network: Server only

ClearPendingFire Source code

ClientWeaponSet Source code

is called by the server to tell the client about potential weapon changes after the player runs over a weapon (the client decides whether to actually switch weapons or not. Network: LocalPlayer
@param bOptionalSet. Set to true if the switch is optional. (simple weapon pickup and weight against current weapon).

ClientWeaponThrown Source code

This function is called when the client needs to discard the weapon

ConsumeAmmo Source code

Consumes ammunition when firing a shot. Subclass me to define weapon ammunition consumption.

CustomFire Source code

If the weapon isn't an instant hit, or a simple projectile, it should use the tyoe EWFT_Custom. In those cases this function will be called. It should be subclassed by the custom weapon.

DemoBeginFire Source code

Passes on BeginFire calls to demos

DemoEndFire Source code

Passes on EndFire calls to demos

DenyClientWeaponSet Source code

Returns true if this weapon wants to deny a ClientWeaponSwitch call

DenyPickupQuery Source code

When you pickup an weapon, the inventory system has a chance to restrict the pickup.

Destroyed Source code

Event called when weapon actor is destroyed

DetachWeapon Source code

Detach weapon components from instigator. Perform any clean up. Should be subclassed.

DisplayDebug Source code

list important Weapon variables on canvas. HUD will call DisplayDebug() on the current ViewTarget when the ShowDebug exec is used
@param HUD - HUD with canvas to draw on
@input out_YL - Height of the current font
@input out_YPos - Y position on Canvas. out_YPos += out_YL, gives position to draw text for next debug line.

DoOverrideNextWeapon Source code

hook to override Next weapon call. For example the physics gun uses it to have mouse wheel change the distance of the held object. Warning: only use in firing state, otherwise it breaks weapon switching

DoOverridePrevWeapon Source code

hook to override Previous weapon call.

DropFrom Source code

Drop this weapon out in to the world
@param StartLocation - The World Location to drop this item from
@param StartVelocity - The initial velocity for the item when dropped

DumpWeaponDebugToLog Source code

Dump debug information for this weapon to log file.

EndFire Source code

Like BeginFire, this function puts a client and the server in sync and shuts down the firing sequence on both. Network: LocalPlayer and Server

EndState PendingClientWeaponSet Source code

Event called when weapon leaves this state

EndState WeaponEquipping Source code

EndState WeaponFiring Source code

EndState WeaponPuttingDown Source code

FireAmmunition Source code

FireAmmunition: Perform all logic associated with firing a shot - Fires ammunition (instant hit or spawn projectile) - Consumes ammunition - Plays any associated effects (fire sound and whatnot) Network: LocalPlayer and Server

FireModeUpdated Source code

Event called when Pawn.FiringMode has been changed. bViaReplication indicates if this was the result of a replication call.

FireOnRelease Source code

FocusOnLeader Source code

ForceEndFire Source code

Clear all pending fires. This is non replicated flag.

GetAdjustedAim Source code

GetAdjustedAim begins a chain of function class that allows the weapon, the pawn and the controller to make on the fly adjustments to where this weapon is pointing.

GetAIRating Source code

AI interface

GetDamageRadius Source code

Returns the DamageRadius of projectiles being shot

GetFireInterval Source code

Returns interval in seconds between each shot, for the firing state of FireModeNum firing mode.
@param FireModeNum fire mode
@return Period in seconds of firing mode

GetMuzzleLoc Source code

This function returns the world location for spawning the visual effects

GetPhysicalFireStartLoc Source code

This function returns the world location for spawning the projectile, pulled in to the Pawn's collision along the AimDir direction.

GetProjectileClass Source code

Returns the type of projectile to spawn. We use a function so subclasses can override it if needed (case in point, homing rockets).

GetTraceOwner Source code

@return the actor that 'owns' this weapon's traces (i.e. can't be hit by them)

GetTraceRange Source code

Range of weapon Used for Traces (CalcWeaponFire, InstantFire, ProjectileFire, AdjustAim...) State scoped accessor function. Override in proper state
@return range of weapon, to be used mainly for traces.

GetViewAxes Source code

Returns the base view aim of the weapon owner

GetWeaponAnimNodeSeq Source code

Returns the AnimNodeSequence the weapon is using to play animations.

GetWeaponDebug Source code

Retrieves important weapon debug information as an array of strings. That can then be dumped or displayed on HUD.

GetWeaponRating Source code

Returns a weight reflecting the desire to use the given weapon, used for AI and player best weapon selection.
@return weapon rating (range -1.f to 1.f)

GivenTo Source code

This Weapon has just been given to this Pawn
@param thisPawn new weapon owner

HasAmmo Source code

This function checks to see if the weapon has any ammo available for a given fire mode.
@param FireModeNum - The Fire Mode to Test For
@param Amount - [Optional] Check to see if this amount is available.
@return true if ammo is available for Firemode FireModeNum.

HasAnyAmmo Source code

returns true if this weapon has any ammo left, regardless of the actual firing mode.

HolderDied Source code

Pawn holding this weapon as active weapon just died.

IncrementFlashCount Source code

Increment Pawn's FlashCount variable. This is used to play weapon fire effects on remote clients. Call this on the server and local player. Network: Server and Local Player

InstantFire Source code

Performs an 'Instant Hit' shot. Also, sets up replication for remote clients, and processes all the impacts to deal proper damage and play effects. Network: Local Player and Server

IsActiveWeapon Source code

Informs if this weapon is active for the player
@return true if this an active weapon for the player

IsFiring Source code

Returns true if the weapon is firing, used by AI

IsFiring WeaponFiring Source code

ItemRemovedFromInvManager Source code

A notification call when this weapon is removed from the Inventory of a pawn @see Inventory::ItemRemovedFromInvManager

MaxRange Source code

Returns the Maximum Range for this weapon

PassThroughDamage Source code

returns true if should pass trace through this hitactor

PendingFire Source code

Pending Fire / Inv Manager

PendingWeaponSetTimer PendingClientWeaponSet Source code

PlayFireEffects Source code

PlayFireEffects Main function to play Weapon fire effects. This is called from Pawn::WeaponFired in the base implementation.

PlayFiringSound Source code

PlayFiringSound - Called after a shot is fired.

PlayWeaponAnimation Source code

Play an animation on the weapon mesh Network: Local Player and clients
@param Anim Sequence to play on weapon skeletal mesh
@param desired duration, in seconds, animation should be played

ProcessInstantHit Source code

Processes a successful 'Instant Hit' trace and eventually spawns any effects. Network: LocalPlayer and Server
@param HitActor Actor hit by trace
@param AimDir Aim direction of shot
@param HitLocation world location vector where HitActor was hit by trace
@param HitNormal hit normal vector
@param HitInto TraceHitInfo struct returning useful info like component hit, bone, material..

ProjectileFire Source code

Fires a projectile. Spawns the projectile, but also increment the flash count for remote client effects. Network: Local Player and Server

PutDownWeapon Source code

This function is called to put a weapon down

RangedAttackTime Source code

ReadyToFire Active Source code

ReadyToFire() called by NPC firing weapon. bFinished should only be true if called from the Finished() function

RecommendLongRangedAttack Source code

RecommendRangedAttack Source code

RefireCheckTimer Source code

RefireCheckTimer WeaponFiring Source code

Timer event, call is set up in Weapon::TimeWeaponFiring(). The weapon is given a chance to evaluate if another shot should be fired. This event defines the weapon's rate of fire.

RelativeStrengthVersus Source code

SendToFiringState Source code

Send weapon to proper firing state Also sets the CurrentFireMode. Network: LocalPlayer and Server
@param FireModeNum Fire Mode.

ServerStartFire Source code

When StartFire() is called on a client, it replicates the start by calling ServerStartFire. This begins the event on server. Server side actors (such as bots) should not call ServerStartFire directly and should instead call StartFire(). Network: Dedicated Server only, or Listen Server for remote clients.

ServerStartFire Inactive Source code

ServerStopFire Source code

When StopFire is called on a client, ServerStopFire is used to initiate the sequence on the server. Network: Dedicated Server only, or Listen Server for remote clients.

ServerStopFire Inactive Source code

SetCurrentFireMode Source code

Set current firing mode. Network: Local Player and Server.

SetFlashLocation Source code

This function sets up the Location of a hit to be replicated to all remote clients. Network: Server only

SetPendingFire Source code

ShouldRefire Source code

Check if current fire mode can/should keep on firing. This is called from a firing state after each shot is fired to decide if the weapon should fire again, or stop and go to the active state. The default behavior, implemented here, is keep on firing while player presses fire and there is enough ammo. (Auto Fire).
@return true to fire again, false to stop firing and return to Active State.

StartFire Source code

Called on the LocalPlayer, Fire sends the shoot request to the server (ServerStartFire) and them simulates the firing effects locally. Call path: PlayerController::StartFire -> Pawn::StartFire -> InventoryManager::StartFire Network: LocalPlayer

StartFire Inactive Source code

do not allow firing in the inactive state

StillFiring Source code

This function returns true if the weapon is still firing in a given mode

StopFire Source code

This initiates the shutdown of a weapon that is firing. Network: Local Player

StopFireEffects Source code

StopFireEffects Main function to stop any active effects This is called from Pawn::WeaponStoppedFiring

StopWeaponAnimation Source code

Stops an animation on the weapon mesh Network: Local Player and clients

SuggestAttackStyle Source code

SuggestDefenseStyle Source code

TimeWeaponEquipping Source code

Sets the timing for equipping a weapon. The WeaponEquipped event is trigged when expired

TimeWeaponFiring Source code

Sets the timing for the firing state on server and local client. By default, a constant looping Rate Of Fire (ROF) is set up. When the delay has expired, the RefireCheckTimer event is triggered. Network: LocalPlayer and Server
@param FireModeNum Fire Mode.

TimeWeaponPutDown Source code

Sets the timing for putting a weapon down. The WeaponIsDown event is trigged when expired

TryPutDown Source code

Put Down current weapon Once the weapon is put down, the InventoryManager will switch to InvManager.PendingWeapon.
@return returns true if the weapon can be put down.

TryPutDown Active Source code

Put the weapon down

TryPutDown Inactive Source code

can't put down an inactive weapon

TryPutDown WeaponPuttingDown Source code

WeaponCalcCamera Source code

WeaponCalcCamera allows a weapon to adjust the pawn's controller's camera. Should be subclassed

WeaponEmpty Source code

Called when the weapon runs out of ammo during firing

WeaponEquipped WeaponEquipping Source code

WeaponIsDown WeaponPuttingDown Source code

We are done putting the weapon away, remove the mesh/etc.

WeaponLog Source code

Prints out weapon debug information to log file
@param Msg String to display
@param FuncStr String telling where the log came from (format: Class::Function)

WeaponPlaySound Source code

This function handles playing sounds for weapons. How it plays the sound depends on the following: If we are a listen server, then this sound is played and replicated as normal If we are a remote client, but locally controlled (ie: we are on the client) we play the sound and don't replicate it If we are a dedicated server, play the sound and replicate it to everyone BUT the owner (he will play it locally).
@param SoundCue - The Source Cue to play

defaultproperties
{
   EquipTime=0.330000
   PutDownTime=0.330000
   bCanThrow=True
   WeaponRange=16384.000000
   DefaultAnimSpeed=1.000000
   Priority=-1.000000
   AIRating=0.500000
   ItemName="Weapon"
   RespawnTime=30.000000
   bReplicateInstigator=True
   bOnlyDirtyReplication=False
   Name="Default__Weapon"
   ObjectArchetype=Inventory'Engine.Default__Inventory'
}