UE3:UTWeap_Translocator (UT3)

Object >> Actor >> Inventory >> Weapon >> GameWeapon >> UTWeapon >> UTWeap_Translocator

Package: 

UTGame

Direct subclass:

UTWeap_Translocator_Content

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

Properties

bTranslocationInProgress

Type: bool

true only during translocation (for kill credit)

DiskEffect

Type: ParticleSystemComponent

DisruptionDeath

Type: SoundCue

EmptyEquipAnim

Type: name

EmptyIdleAnim

Type: name

Anim when the disc is deployed

EmptyPutDownAnim

Type: name

FailedTranslocationDamageClass

Type: class<UTDamageType>

GeneralSkin

Type: MaterialInstanceConstant

RechargeRate

Type: float

How fast the TL recharges

Default value: 1.25

SkinColors

Type: Object.LinearColor

Array size: 2

Default value, index 0:

Member	Value
A	1.0
B	0.0
G	0.0
R	0.0

Default value, index 1:

Member	Value
A	1.0
B	0.0
G	0.0
R	0.0

TeamSkins

Type: MaterialInterface

Array size: 4

Skins

TransDisc

Type: UTProj_TransDisc

Modifiers: repnotify

Access to the disc in the world

TransFailedSound

Type: SoundCue

Animations and Sounds

TransRecalledSound

Type: SoundCue

Default values

Property	Value
AIRating	-1.0
AmmoCount	7
bCanThrow	False
bExportMenuData	False
CurrentRating	-1.0
FireInterval[0]	0.25
FireInterval[1]	0.25
FireOffset	Member Value X 15.0 Y 8.0 Z -10.0
GroupWeight	0.6
ItemName	"Translocator"
MaxAmmoCount	7
PickupMessage	"Translocator"
Priority	0.6
ShotCost[0]	0
WeaponColor	Member Value A 255 B 128 G 255 R 255

Subobjects

FirstPersonMesh

Class: UTGame.UTSkeletalMeshComponent

Inherits from: UTWeapon.FirstPersonMesh

No new values.

PickupMesh

Class: Engine.SkeletalMeshComponent

Inherits from: UTWeapon.PickupMesh

No new values.

Functions

Events

GetPowerPerc

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 )

PostBeginPlay

simulated event PostBeginPlay ()

Overrides: UTWeapon.PostBeginPlay

Initialize the weapon

ReplicatedEvent

simulated event ReplicatedEvent (name VarName)

Overrides: UTWeapon.ReplicatedEvent

Other instance functions

AttemptTranslocation

function bool AttemptTranslocation (Object.Vector dest)

BotTranslocation

function bool BotTranslocation ()

ConsumeAmmo

function ConsumeAmmo (byte FireModeNum)

Overrides: UTWeapon.ConsumeAmmo

We need to override ConsumeAmmo and set the recharge timer.

CustomFire

simulated function CustomFire ()

Overrides: Weapon.CustomFire

Alt-Fire on this weapon is custom and this is it's stub. It should attempt to translocate.

DenyClientWeaponSet

simulated function bool DenyClientWeaponSet ()

Overrides: Weapon.DenyClientWeaponSet

Returns true if this weapon wants to deny a ClientWeaponSwitch call

FireHack

function FireHack ()

Overrides: UTWeapon.FireHack

FireHackTimer

simulated function FireHackTimer ()

FragInstigator

function FragInstigator (class<DamageType> DmgClass)

The function will kill the player holding the TL if it's disrupted

GetAIRating

function float GetAIRating ()

Overrides: Weapon.GetAIRating

AI interface

GivenTo

function GivenTo (Pawn ThisPawn, optional bool bDoNotActivate)

Overrides: UTWeapon.GivenTo

(Description copied from Weapon.GivenTo)
This Weapon has just been given to this Pawn

Parameters:

• thisPawn - new weapon owner

HasAmmo

simulated function bool HasAmmo (byte FireModeNum, optional int Amount)

Overrides: UTWeapon.HasAmmo

Override CheckAmmo to return 0 if ammo count = 0 regardless of the cost

HolderDied

function HolderDied ()

Overrides: Weapon.HolderDied

Pawn holding this weapon as active weapon just died.

ItemRemovedFromInvManager

function ItemRemovedFromInvManager ()

Overrides: Weapon.ItemRemovedFromInvManager

(Description copied from Weapon.ItemRemovedFromInvManager)
A notification call when this weapon is removed from the Inventory of a pawn

See: Inventory::ItemRemovedFromInvManager

PlayFiringSound

simulated function PlayFiringSound ()

Overrides: UTWeapon.PlayFiringSound

Tells the weapon to play a firing sound (uses CurrentFireMode)

PlayWeaponEquip

simulated function PlayWeaponEquip ()

Overrides: UTWeapon.PlayWeaponEquip

Show the weapon begin equipped

PlayWeaponPutDown

simulated function PlayWeaponPutDown ()

Overrides: UTWeapon.PlayWeaponPutDown

Show the weapon being put away

ProjectileFire

simulated function Projectile ProjectileFire ()

Overrides: UTWeapon.ProjectileFire

If there isn't a disc, launch one, if there is, recall it.

ReAddAmmo

simulated function ReAddAmmo ()

Add ammo back in to the weapon

SetSkin

simulated function SetSkin (Material NewMaterial)

Overrides: UTWeapon.SetSkin

(Description copied from UTWeapon.SetSkin)
Material control

Parameters:

• NewMaterial - The new material to apply or none to clear it

ShouldTranslocatorHop

function bool ShouldTranslocatorHop (UTBot B)

StartFire

simulated function StartFire (byte FireModeNum)

Overrides: UTWeapon.StartFire

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

TranslocSucceeded

function bool TranslocSucceeded (Object.Vector dest)

WeaponEmpty

simulated function WeaponEmpty ()

Overrides: UTWeapon.WeaponEmpty

Called when the weapon runs out of ammo during firing

States

Active

Inherits from: UTWeapon.Active

Modifiers: simulated

Active.BeginState

simulated event BeginState (name PreviousStateName)

Overrides: UTWeapon.Active.BeginState

Initialize the weapon as being active and ready to go.

RecallFire

Extends: WeaponFiring

RecallFire.ShouldLagRot

simulated function bool ShouldLagRot ()

Overrides: UTWeapon.ShouldLagRot (global)

(Description copied from UTWeapon.ShouldLagRot)

Returns:

whether the weapon's rotation is allowed to lag behind the holder's rotation

WeaponFiring

WeaponFiring.FireAmmunition

simulated function FireAmmunition ()

Overrides: UTWeapon.FireAmmunition (global)

Deactiveate Spawn Protection

WeaponFiring.ShouldRefire

simulated function bool ShouldRefire ()

Overrides: Weapon.ShouldRefire (global)

See: WarWeapon::ShouldRefire()