Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation
previous class next class | frames no frames

# Gameplay.MPCarryableContainer

Extends
  MPArea

    Core.Object
    |
    +-- Engine.Actor
       |
       +-- Engine.Pawn
          |
          +-- Gameplay.Rook
             |
             +-- Gameplay.MPActor
                |
                +-- Gameplay.MPArea
                   |
                   +-- Gameplay.MPCarryableContainer

Variables Summary
bool | bDepositEffect
bool | bFull
bool | bFullEffect
bool | bInactiveEffect
bool | bLocalDepositEffect
bool | bLocalFullEffect
bool | bLocalInactiveEffect
bool | bLocalWithdrawEffect
bool | bWithdrawEffect
Shader | fuelShader
ControllableTexturePanner | fuelTexPanner
Shader | innerFuelShader
ControllableTexturePanner | innerFuelTexPanner
float | lastWithdrawAnnouncementTime
Array<MPCarryable> | storedCarryables
EffectEvents
Name | activatedEffectEvent
Name | activeEffectEvent
Name | deactivatedEffectEvent
Name | depositedEffectEvent
Name | fullEffectEvent
Name | withdrawnEffectEvent
LocalMessage
class<Engine.Localmessage> | ContainerMessageClass
MPCarryableContainer
Name | activatedAnimation
bool | bAcceptThrownCarryables
class<MPCarryable> | carryableClass
int | carryablesPerTeamPoint
Name | deactivatedAnimation
Name | depositedAnimation
int | fuelMaterialIndex
Name | fullAnimation
float | halfFullWithdrawScale
int | innerFuelMaterialIndex
int | maxCarryables
float | nearlyEmptyWithdrawScale
float | nearlyFullWithdrawScale
int | numCarryables
int | numWithdrawnPerSpawn
float | timeBetweenWithdrawals
int | timeBetweenWithdrawAnnouncements
Name | withdrawnAnimation
Stats
class<Stat> | depositStat

Inherited Variables from Gameplay.MPArea
areaOffset, areaTrigger, areaTriggerClass

Inherited Variables from Gameplay.MPActor
attackRadius, attackStat, bAllowSpectators, defendRadius, defendStat, idleAnim, localizedName, primaryEnemyObjectiveDesc, primaryFriendlyObjectiveDesc, primaryNeutralObjectiveDesc, secondaryMessageClass, spectatorList

Enumerations Summary
EContainerObjectiveState COS_Empty, COS_HalfFull, COS_Full

Functions Summary
|  | addCarryable (MPCarryable c))
|  | addCarryable (MPCarryable c)) Inactive
|  | addMetaCarryable (MPMetaCarryable meta))
|  | addNewCarryables (int numToAdd))
| bool | allowSpawn ()))
|  | BeginState ())) Active
|  | BeginState ())) Full
|  | BeginState ())) Inactive
|  | buildControllableSkin ()))
|  | calcFuelPannerScale ()))
|  | cleanup ()))
| int | deposit (Character c))
| int | deposit (Character c)) Full
|  | EndState ())) Full
|  | EndState ())) Inactive
|  | evaluateContents ()))
|  | evaluateObjectiveState ()))
|  | evaluatePercentageContents (int numAdded))
|  | onAreaEntered (Character c))
|  | onAreaEntered (Character c)) Active
|  | onAreaExited (Character c))
|  | onAreaExited (Character c)) Active
|  | onAreaTick ()))
|  | onAreaTick ())) Active
|  | onPlayerSpawned (Character c))
|  | PostBeginPlay ()))
|  | PostNetBeginPlay ()))
|  | PostNetReceive ()))
|  | registerStats (StatTracker tracker))
| MPCarryable | removeCarryable ()))
|  | reset ()))
|  | Tick (float Delta)) Active
|  | updateContainerEffects ()))
|  | withdraw (Character c))
|  | withdraw (Character c)) Full

Inherited Functions from Gameplay.MPArea
cleanup, OnAreaEntered, OnAreaEnteredByActor, OnAreaExited, OnAreaExitedByActor, OnAreaTick, PostBeginPlay

Inherited Functions from Gameplay.MPActor
addDefaultObjectives, addEnemyObjective, addFriendlyObjective, addNeutralObjective, addSpectator, awardStat, cleanup, contractLattice, evaluateObjectiveState, expandLattice, GetHumanReadableName, getNearest, getPersonalObjectiveName, getUniqueObjectiveName, getViewTarget, incrementStatAttempt, onAvailableToLattice, onPlayerKilled, onUnavailableToLattice, PostBeginPlay, PostTakeDamage, registerStats, removeDefaultObjectives, removePersonalObjective, removeSpectator, resetSpectatorViewTarget, scoreIndividual, scoreTeam, setObjectiveState, setObjectiveTally, setPersonalObjective, setSpectatorViewTarget

States Summary

Active Source code
auto simulated state Active

BeginState, onAreaEntered, onAreaExited, onAreaTick, Tick

Full Source code
state Full extends Inactive

BeginState, deposit, EndState, withdraw

Inactive Source code
state Inactive

addCarryable, BeginState, EndState

Paused Source code
state Paused

Variables Detail

#### bDepositEffect Source code

var bool bDepositEffect;

#### bFull Source code

var bool bFull;

#### bFullEffect Source code

var bool bFullEffect;

#### bInactiveEffect Source code

var bool bInactiveEffect;

#### bLocalDepositEffect Source code

var bool bLocalDepositEffect;

#### bLocalFullEffect Source code

var bool bLocalFullEffect;

#### bLocalInactiveEffect Source code

var bool bLocalInactiveEffect;

#### bLocalWithdrawEffect Source code

var bool bLocalWithdrawEffect;

#### bWithdrawEffect Source code

var bool bWithdrawEffect;

#### fuelShader Source code

var Shader fuelShader;

#### fuelTexPanner Source code

var ControllableTexturePanner fuelTexPanner;

#### innerFuelShader Source code

var Shader innerFuelShader;

#### innerFuelTexPanner Source code

var ControllableTexturePanner innerFuelTexPanner;

#### lastWithdrawAnnouncementTime Source code

var float lastWithdrawAnnouncementTime;

#### storedCarryables Source code

var Array<MPCarryable> storedCarryables;

### EffectEvents

#### activatedEffectEvent Source code

var(EffectEvents) Name activatedEffectEvent;

> The name of an effect event that plays once when the container becomes active

#### activeEffectEvent Source code

var(EffectEvents) Name activeEffectEvent;

> The name of an effect event that loops while the container is active

#### deactivatedEffectEvent Source code

var(EffectEvents) Name deactivatedEffectEvent;

> The name of an effect event that plays once when the container becomes inactive

#### depositedEffectEvent Source code

var(EffectEvents) Name depositedEffectEvent;

> The name of an effect event that plays once when the container accepts a deposit

#### fullEffectEvent Source code

var(EffectEvents) Name fullEffectEvent;

> The name of an effect event that plays once when the container becomes full

#### withdrawnEffectEvent Source code

var(EffectEvents) Name withdrawnEffectEvent;

> The name of an effect event that plays once when the container accepts a withdrawal

### LocalMessage

#### ContainerMessageClass Source code

var(LocalMessage) class<Engine.Localmessage> ContainerMessageClass;

> The class used for playing effects and displaying messages

### MPCarryableContainer

#### activatedAnimation Source code

var(MPCarryableContainer) Name activatedAnimation;

> The looping animation to play while the container is active

#### bAcceptThrownCarryables Source code

var(MPCarryableContainer) bool bAcceptThrownCarryables;

> Does this container allow carryables to be thrown into it?

#### carryableClass Source code

var(MPCarryableContainer) class<MPCarryable> carryableClass;

> The class which is stored in this container

#### carryablesPerTeamPoint Source code

var(MPCarryableContainer) int carryablesPerTeamPoint;

> The number of carryables needed to score a team point

#### deactivatedAnimation Source code

var(MPCarryableContainer) Name deactivatedAnimation;

> The animation to play when the container becomes inactive

#### depositedAnimation Source code

var(MPCarryableContainer) Name depositedAnimation;

> The animation to play when the container accepts a deposit

#### fuelMaterialIndex Source code

var(MPCarryableContainer) int fuelMaterialIndex;

> The index at which the fuel material resides

#### fullAnimation Source code

var(MPCarryableContainer) Name fullAnimation;

> The animation to play when the container becomes full

#### halfFullWithdrawScale Source code

var(MPCarryableContainer) float halfFullWithdrawScale;

> When the container is between 25% and 75% full, time between withdrawals will be scaled by this amount

#### innerFuelMaterialIndex Source code

var(MPCarryableContainer) int innerFuelMaterialIndex;

> The index at which the inner fuel material resides

#### maxCarryables Source code

var(MPCarryableContainer) int maxCarryables;

> The maximum number of carryables this container can hold before becoming full

#### nearlyEmptyWithdrawScale Source code

var(MPCarryableContainer) float nearlyEmptyWithdrawScale;

> When the container is less than 25% full, time between withdrawals will be scaled by this amount

#### nearlyFullWithdrawScale Source code

var(MPCarryableContainer) float nearlyFullWithdrawScale;

> When the container is more than 75% full, time between withdrawals will be scaled by this amount

#### numCarryables Source code

var(MPCarryableContainer) int numCarryables;

> The number of carryables this container starts with

#### numWithdrawnPerSpawn Source code

var(MPCarryableContainer) int numWithdrawnPerSpawn;

> The number of carryables to withdraw from the container and give to a player each time the player spawns.

#### timeBetweenWithdrawals Source code

var(MPCarryableContainer) float timeBetweenWithdrawals;

> The number of seconds you must wait in between each carryable withdrawal

#### timeBetweenWithdrawAnnouncements Source code

var(MPCarryableContainer) int timeBetweenWithdrawAnnouncements;

#### withdrawnAnimation Source code

var(MPCarryableContainer) Name withdrawnAnimation;

> The animation to play when the container accepts a withdrawal

### Stats

#### depositStat Source code

var(Stats) class<Stat> depositStat;

> The stat awarded for depositing each carryable in this container.

Enumerations Detail

#### EContainerObjectiveState Source code

enum EContainerObjectiveState
{

> COS_Empty, COS_HalfFull, COS_Full

};

Functions Detail

#### addCarryable Source code

function addCarryable ( MPCarryable c) )

#### addCarryable Inactive Source code

function addCarryable ( MPCarryable c) )

#### addMetaCarryable Source code

function addMetaCarryable ( MPMetaCarryable meta) )

#### addNewCarryables Source code

function addNewCarryables ( int numToAdd) )

#### allowSpawn Source code

function bool allowSpawn ( ) )

#### BeginState Active Source code

simulated function BeginState ( ) )

#### BeginState Full Source code

function BeginState ( ) )

#### BeginState Inactive Source code

function BeginState ( ) )

#### buildControllableSkin Source code

simulated function buildControllableSkin ( ) )

#### calcFuelPannerScale Source code

simulated function calcFuelPannerScale ( ) )

#### cleanup Source code

function cleanup ( ) )

#### deposit Source code

function int deposit ( Character c) )

#### deposit Full Source code

function int deposit ( Character c) )

#### EndState Full Source code

function EndState ( ) )

#### EndState Inactive Source code

function EndState ( ) )

#### evaluateContents Source code

function evaluateContents ( ) )

#### evaluateObjectiveState Source code

function evaluateObjectiveState ( ) )

#### evaluatePercentageContents Source code

function evaluatePercentageContents ( int numAdded) )

#### onAreaEntered Source code

function onAreaEntered ( Character c) )

#### onAreaEntered Active Source code

function onAreaEntered ( Character c) )

#### onAreaExited Source code

function onAreaExited ( Character c) )

#### onAreaExited Active Source code

function onAreaExited ( Character c) )

#### onAreaTick Source code

function onAreaTick ( ) )

#### onAreaTick Active Source code

function onAreaTick ( ) )

#### onPlayerSpawned Source code

function onPlayerSpawned ( Character c) )

#### PostBeginPlay Source code

simulated function PostBeginPlay ( ) )

#### PostNetBeginPlay Source code

simulated function PostNetBeginPlay ( ) )

#### PostNetReceive Source code

simulated function PostNetReceive ( ) )

#### registerStats Source code

function registerStats ( StatTracker tracker) )

#### removeCarryable Source code

function MPCarryable removeCarryable ( ) )

#### reset Source code

function reset ( ) )

#### Tick Active Source code

simulated function Tick ( float Delta) )

#### updateContainerEffects Source code

simulated function updateContainerEffects ( ) )

#### withdraw Source code

function withdraw ( Character c) )

#### withdraw Full Source code

function withdraw ( Character c) )

Defaultproperties

    defaultproperties
    {
    	DrawType				= DT_StaticMesh
    	StaticMesh				= StaticMesh'Editor_res.TexPropCube'
    	bCollideActors			= true
    	bCollideWorld			= true

    	bMovable				= false
    	bUseCylinderCollision	= false
    	bBlockPlayers			= false
    	bNetNotify				= true
    	carryablesPerTeamPoint		= 10
    	carryableClass				= class'MPCarryable'
    	maxCarryables				= 10
    	bAcceptThrownCarryables		= true
    	timeBetweenWithdrawals	= 2
    	fuelMaterialIndex		= 2
    	ContainerMessageClass	= class'MPContainerMessages'
    	timeBetweenWithdrawAnnouncements = 10
    	bAlwaysRelevant			= true

    	nearlyEmptyWithdrawScale = 1.5
    	nearlyFullWithdrawScale	= 0.5
    	halfFullWithdrawScale	= 1.0

    	deactivatedEffectEvent	= Deactivated
    	activatedEffectEvent	= Activated
    	fullEffectEvent			= Full
    	depositedEffectEvent	= Deposited
    	withdrawnEffectEvent	= Withdrawn
    	activeEffectEvent		= Active

    	NetUpdateFrequency		= 4
    }

Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation
previous class next class | frames no frames

Creation time: st 23.5.2018 00:10:32.892 - Created with UnCodeX