represents base for cargo storage for entities More...

Inheritance diagram for CargoBase:

Collaboration diagram for CargoBase:

Private Member Functions
proto native EntityAI	GetCargoOwner ()
	get the entity that owns the cargo

proto native int	GetOwnerCargoIndex ()

proto native bool	IsProxyCargo ()

proto native int	GetItemCount ()

proto native EntityAI	GetItem (int index)

proto native int	GetWidth ()

proto native int	GetHeight ()

proto bool	GetItemRowCol (int index, out int row, out int col)

proto bool	GetItemSize (int index, out int w, out int h)

proto native int	FindEntityInCargo (notnull EntityAI e)

void	CargoBase ()

void	~CargoBase ()

bool	CanReceiveItemIntoCargo (EntityAI item)
	condition EntityAI::CanReceiveItemIntoCargo for Cargo.

bool	CanSwapItemInCargo (EntityAI child_entity, EntityAI new_entity)
	condition EntityAI::CanSwapItemInCargo for Cargo.

proto native int	GetUserReservedLocationCount ()

proto bool	GetUserReservedLocation (int index, out EntityAI eai, out int row, out int col, out int w, out int h, out int flp)

proto native void	SetUserReservedLocation (notnull EntityAI eai)

proto native void	ClearUserReservedLocation (notnull EntityAI eai)

Private Member Functions inherited from Managed
void	IntroSceneCharacter ()

void	~IntroSceneCharacter ()

bool	IsDefaultCharacter ()

void	SetToDefaultCharacter ()

void	SetCharacterID (int char_id)

int	GetCharacterID ()

PlayerBase	GetCharacterObj ()

TStringArray	GetCharGenderList ()

TStringArray	GetCharList (ECharGender gender)

TStringArray	GetCharShirtsList ()

TStringArray	GetCharPantsList ()

TStringArray	GetCharShoesList ()

void	SetCharacterGender (ECharGender gender)

bool	IsCharacterFemale ()

ECharGender	GetCharacterGender ()

vector	GetPosition ()

int	GetNextCharacterID ()

int	GetPrevCharacterID ()

void	CreateNewCharacterRandom ()

void	CreateNewCharacterById (int character_id)

void	CreateNewCharacterByName (string character_name, bool randomize_equip=true)

void	CreateDefaultCharacter ()

void	GetLastPlayedServer (int characterID, out string address, out string name, out int port)

void	CreateNewCharacter ()

void	LoadCharacterData (vector char_pos, vector char_rot, bool default_char=false)
	Generates random equip for the new IntroSceneCharacter, whatever is defined in 'cfgCharacterCreation'.

void	CharacterUnload ()

void	CharacterLoad (int character_id, vector char_pos, vector char_rot)

void	SetupPlayerName (bool new_name)

void	SetAttachment (string type, int slot)

string	GetCharacterNameById (int char_id)

string	GetCharacterName ()

void	SaveCharName (string name)

void	SaveDefaultCharacter ()

void	TransferValues (PlayerBase player)

void	Init ()

void	OnScheduledTick (float deltatime)

void	CheckValues ()

float	GetBlood ()

float	GetHealth ()

void	CheckHealth ()

void	CheckBlood ()

void	SendInitValues ()
	Sends values on object creation.

void	SendValue (int value_type, float value)

void	ReceiveValue (int value_type, float value)

void	OnRPC (ParamsReadContext ctx)

void	ShowDebugValues (bool show)

void	BleedingIndicator (int source_ID, int severity, GameplayEffectsDataBleeding parent)

void	InitIndicator (vector position)

void	StopIndicator (bool instant=false)

void	StartRunningDrops ()

bool	IsRunningDrops ()
	Are any drops currently being animated?

void	TrySpawnNextDrop ()

void	ResetSequence ()

void	ResetIndicator ()

void	Update (float timeSlice)

bool	GetEndNow ()

int	GetSeverity ()

void	GameplayEffectsData (array< ref Widget > input, int type, int user_override=-1)

void	Init (array< ref Widget > input, int type, Widget layout_root, int user_override=-1)

array< ref Widget >	GetWidgetSet ()

int	GetWidgetSetType ()

int	GetWidgetSetID ()

bool	HasDefinedHandle ()
	Returns 'true' if this class contains update info.

bool	DataInitialized ()

void	UpdateVisibility (bool state)

void	RegisterData (Param p)

void	Update (float timeSlice=0, Param p=null, int handle=-1)

void	ForceStop ()

Additional Inherited Members
Private Attributes inherited from Managed
int	m_CharacterId

string	m_CharacterType

MenuData	m_CharacterDta

PlayerBase	m_CharacterObj

vector	m_CharacterPos

vector	m_CharacterRot

ref TStringArray	m_CharGenderList = new TStringArray

ref TStringArray	m_CharShirtList = new TStringArray

ref TStringArray	m_CharPantsList = new TStringArray

ref TStringArray	m_CharShoesList = new TStringArray

ref map< ECharGender, ref array< string > >	m_Characters = new map<ECharGender, ref array<string>>

ECharGender	m_CharGender

bool	m_InitialSyncSent

bool	m_Initialized

bool	m_Terminating = false

bool	m_EndNow = false

bool	m_IsRunning = false

int	m_DropSpawnsQueued

int	m_ActiveDropsCount

int	m_Severity

int	m_SourceID

GameplayEffectsDataBleeding	m_ParentMetaData

array< float >	m_DropProbabilityArray

float	m_AverageFrequency

float	m_SequenceTick

float	m_SequenceDuration

float	m_TimeElapsedTotal

float	m_TimeElapsedSequence

float	m_LastDropSpawnTime

float	m_DropSpawnMinDelay

float	m_DropSpawnMaxDelay

int	m_CurrentDropProbabilityStep

int	m_DropProbabilityRollsCount

vector	m_BasePosition

ref set< ref BleedingIndicatorDropData >	m_ActiveDrops

ref set< int >	m_CleanupQueue

ref array< ref Widget >	m_WidgetArray

int	m_Type

int	m_WidgetSetIdentifier

Widget	m_LayoutRoot

Detailed Description

represents base for cargo storage for entities

@NOTE: rows == y axis

Definition at line 6 of file Cargo.c.

Constructor & Destructor Documentation

◆ CargoBase()

void CargoBase::CargoBase ( )

private

◆ ~CargoBase()

void CargoBase::~CargoBase ( )

private

Member Function Documentation

◆ CanReceiveItemIntoCargo()

CargoBase::CanReceiveItemIntoCargo ( EntityAI item )

inlineprivate

condition EntityAI::CanReceiveItemIntoCargo for Cargo.

Returns: true if cargo can be added, false otherwise

Definition at line 65 of file Cargo.c.

65{ return true; }

◆ CanSwapItemInCargo()

CargoBase::CanSwapItemInCargo	(	EntityAI	child_entity,
		EntityAI	new_entity )

inlineprivate

condition EntityAI::CanSwapItemInCargo for Cargo.

Returns: true if cargo can be added, false otherwise

Definition at line 71 of file Cargo.c.

71{ return true; }

◆ ClearUserReservedLocation()

proto native void CargoBase::ClearUserReservedLocation ( notnull EntityAI eai )

private

◆ FindEntityInCargo()

CargoBase::FindEntityInCargo ( notnull EntityAI e )

private

Returns: find internal index of the entity in cargo or -1 if not found

◆ GetCargoOwner()

CargoBase::GetCargoOwner ( )

private

get the entity that owns the cargo

Returns: cargo owner

◆ GetHeight()

CargoBase::GetHeight ( )

private

Returns: height of the cargo

Referenced by Container::GetMaxCargoCapacity().

◆ GetItem()

CargoBase::GetItem ( int index )

private

Returns: get item at specific index

Referenced by Container::AddedToCargoEx(), Container::GetIcon(), Container::RemovedFromCargo(), and Container::SetEntity().

◆ GetItemCount()

CargoBase::GetItemCount ( )

private

Returns: number of items in cargo

Referenced by Container::AddedToCargoEx(), Container::GetCargoCapacity(), Container::GetIcon(), Container::RemovedFromCargo(), and Container::SetEntity().

◆ GetItemRowCol()

CargoBase::GetItemRowCol	(	int	index,
		out int	row,
		out int	col )

private

Parameters

[out]	row	returned row of the item at internal index
[out]	col	returned col. 0 on xbox

◆ GetItemSize()

CargoBase::GetItemSize	(	int	index,
		out int	w,
		out int	h )

private

Parameters

[out]	w	returned width of the item at internal index
[out]	h	returned height of the item at internal index

Referenced by Container::GetCargoCapacity().

◆ GetOwnerCargoIndex()

proto native int CargoBase::GetOwnerCargoIndex ( )

private

◆ GetUserReservedLocation()

CargoBase::GetUserReservedLocation	(	int	index,
		out EntityAI	eai,
		out int	row,
		out int	col,
		out int	w,
		out int	h,
		out int	flp )

private

Parameters

[in]	idx	index of the user reserved location
[out]	eai	returned entity of the user reservation at internal index
[out]	row	returned row of the user reservation at internal index
[out]	col	returned col
[out]	w	returned width of the user reservation at internal index
[out]	h	returned height of the user reservation at internal index
[out]	flp	returned flip

Returns: true if record found, false otherwise

◆ GetUserReservedLocationCount()

proto native int CargoBase::GetUserReservedLocationCount ( )

private

◆ GetWidth()

CargoBase::GetWidth ( )

private

Returns: width of the cargo

Referenced by Container::GetMaxCargoCapacity().

◆ IsProxyCargo()

CargoBase::IsProxyCargo ( )

private

Returns: true if cargo is in proxy object

◆ SetUserReservedLocation()

proto native void CargoBase::SetUserReservedLocation ( notnull EntityAI eai )

private

The documentation for this class was generated from the following file:

scripts/3_Game/Systems/Inventory/Cargo.c

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CargoBase()

◆ ~CargoBase()

Member Function Documentation

◆ CanReceiveItemIntoCargo()

◆ CanSwapItemInCargo()

◆ ClearUserReservedLocation()

◆ FindEntityInCargo()

◆ GetCargoOwner()

◆ GetHeight()

◆ GetItem()

◆ GetItemCount()

◆ GetItemRowCol()

◆ GetItemSize()

◆ GetOwnerCargoIndex()

◆ GetUserReservedLocation()

◆ GetUserReservedLocationCount()

◆ GetWidth()

◆ IsProxyCargo()

◆ SetUserReservedLocation()