Inheritance diagram for SCR_EditableVehicleUIInfo:

[legend]

Public Member Functions
bool	GetEditorPlaceAsOneGroup ()
	Get bool if spawned characters should be placed as one if placing the vehicle with crew and passenger flags.

int	GetOccupantFillCompartmentTypes (out notnull array< ECompartmentType > compartmentTypes)
	Get an array of compart ment types this vehicle can be filled with.

bool	CanFillWithCrew ()
	Checks if editor is allowed to fill vehicle with given Crew.

bool	CanFillWithPassengers ()
	Checks if editor is allowed to fill vehicle with given Passengers.

bool	CanFillWithGivenTypes (array< ECompartmentType > typesToCheck)
	Checks if editor is allowed to fill vehicle with given occupant types.

void	GetFillBudgetCostsOfCrew (out notnull array< ref SCR_EntityBudgetValue > budgetCosts)
	Returns an array of of budgets for crew.

void	GetFillBudgetCostsOfPassengers (out notnull array< ref SCR_EntityBudgetValue > budgetCosts)
	Returns an array of of budgets for crew.

Public Member Functions inherited from SCR_EditableEntityUIInfo
override LocalizedString	GetName ()
	Get name.

bool	IsFullBackgroundAssetCard ()

ResourceName	GetImage ()

EEditableEntityType	GetEntityTypex ()

FactionKey	GetFactionKey ()

Faction	GetFaction ()

int	GetEntityLabels (out notnull array< EEditableEntityLabel > entityLabels)
	Fill the provided array with auto and authored labels.

bool	HasEntityLabel (EEditableEntityLabel label)
	Check if entity has label in either Auto or Authored labels.

bool	GetEntityBudgetCost (out notnull array< ref SCR_EntityBudgetValue > outBudgets)
	Get Entity budget costs.

void	GetEntityAndChildrenBudgetCost (out notnull array< ref SCR_EntityBudgetValue > outBudgets)
	Get Entity and its children budgets.

void	GetEntityChildrenBudgetCost (out notnull array< ref SCR_EntityBudgetValue > outBudgets)
	Get only Entity's children budget costs, i.e. cost of entities inside a composition entitiy.

ResourceName	GetSlotPrefab ()
	Get prefab this entity prefab extends.

EEditableEntityType	GetEntityType ()
	Get entity type.

bool	HasEntityFlag (EEditableEntityFlag flag)
	Check if a flag is active.

bool	SetAssetImageTo (ImageWidget imageWidget)
	Set asset image to given image widget and stretches if is full background flagged.

void	InitFromSource (IEntityComponentSource componentSource)
	Initialise UI info from component source.

Public Member Functions inherited from SCR_UIInfo
ResourceName	GetIconPath ()
	Get icon.

string	GetIconSetName ()
	Returns Icon Set name if imageset.

bool	HasIcon ()
	Check if the info has an icon defined.

bool	SetIconTo (ImageWidget imageWidget)
	Set icon to given image widget.

override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)

Public Member Functions inherited from SCR_UIDescription
LocalizedString	GetUnformattedDescription ()
	Get the unformatted description from SCR_HintUIInfo instance.

void	SetDescription (LocalizedString description)
	Change the description from SCR_HintUIInfo instance.

LocalizedString	GetDescription ()
	Get description.

bool	HasDescription ()
	Check if the info has a description defined.

bool	SetDescriptionTo (TextWidget textWidget)
	Set description to given text widget.

override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)

Public Member Functions inherited from SCR_UIName
LocalizedString	GetUnformattedName ()
	Get The unformatted Name from SCR_HintUIInfo instance.

void	SetName (LocalizedString name)
	Change the Name from SCR_HintUIInfo instance.

LocalizedString	GetName ()
	Get name.

bool	HasName ()
	Check if the info has a name defined.

bool	SetNameTo (TextWidget textWidget)
	Set name to given text widget.

void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)
	Print out contents of this UI info.

Protected Attributes
bool	m_bEditorPlaceAsOneGroup

ref array< ECompartmentType >	m_aOccupantFillCompartmentTypes

Protected Attributes inherited from SCR_EditableEntityUIInfo
ResourceName	m_SlotPrefab

bool	m_bFullBackgroundAssetCard

EEditableEntityType	m_EntityType

EEditableEntityFlag	m_EntityFlags

Protected Attributes inherited from SCR_UIInfo
ResourceName	Icon

string	IconSetName

Protected Attributes inherited from SCR_UIDescription
LocalizedString	Description

Protected Attributes inherited from SCR_UIName
LocalizedString	Name

Additional Inherited Members
Static Public Member Functions inherited from SCR_UIInfo
static SCR_UIInfo	GetInfo (BaseContainer source, string varName)
	Get UIInfo from a source object.

static SCR_UIInfo	CreateInfo (UIInfo source)
	Create SCR_UIInfo from engine UIInfo.

static SCR_UIInfo	CreateInfo (LocalizedString name, LocalizedString description=LocalizedString.Empty, ResourceName icon=ResourceName.Empty, string iconSetName=string.Empty)
	Create SCR_UIInfo from basic params.

static SCR_UIInfo	CreatePlaceholderInfo (TypeName type)
	Get placeholder info.

Static Public Attributes inherited from SCR_EditableEntityUIInfo
static const LocalizedString	EDITABLE_ENTITY_FALLBACK_NAME = "#AR-AttributesDialog_TitlePage_Entity_Text"

Protected Member Functions inherited from SCR_EditableEntityUIInfo
override void	CopyFrom (SCR_UIName source)

override void	CopyFrom (SCR_UIName source)

override void	CopyFrom (SCR_UIName source)

void	CopyFrom (SCR_UIName source)

Member Function Documentation

◆ CanFillWithCrew()

bool SCR_EditableVehicleUIInfo.CanFillWithCrew ( )

Checks if editor is allowed to fill vehicle with given Crew.

Returns: Returns true if can fill with Crew

◆ CanFillWithGivenTypes()

bool SCR_EditableVehicleUIInfo.CanFillWithGivenTypes ( array< ECompartmentType > typesToCheck )

Checks if editor is allowed to fill vehicle with given occupant types.

Parameters

typesToCheck given Occupant types

Returns: Returns true if at least one of the given occupent types is true

◆ CanFillWithPassengers()

bool SCR_EditableVehicleUIInfo.CanFillWithPassengers ( )

Checks if editor is allowed to fill vehicle with given Passengers.

Returns: Returns true if can fill with Passengers

◆ GetEditorPlaceAsOneGroup()

bool SCR_EditableVehicleUIInfo.GetEditorPlaceAsOneGroup ( )

Get bool if spawned characters should be placed as one if placing the vehicle with crew and passenger flags.

Returns: If editor should place as one group or not

◆ GetFillBudgetCostsOfCrew()

void SCR_EditableVehicleUIInfo.GetFillBudgetCostsOfCrew ( out notnull array< ref SCR_EntityBudgetValue > budgetCosts )

Returns an array of of budgets for crew.

Parameters

[out] budgetCosts Crew budget costs

◆ GetFillBudgetCostsOfPassengers()

void SCR_EditableVehicleUIInfo.GetFillBudgetCostsOfPassengers ( out notnull array< ref SCR_EntityBudgetValue > budgetCosts )

Returns an array of of budgets for crew.

Parameters

[out] budgetCosts Crew budget costs

◆ GetOccupantFillCompartmentTypes()

int SCR_EditableVehicleUIInfo.GetOccupantFillCompartmentTypes ( out notnull array< ECompartmentType > compartmentTypes )

Get an array of compart ment types this vehicle can be filled with.

Parameters

[out] array of compartment types

Returns: count of array

Member Data Documentation

◆ m_aOccupantFillCompartmentTypes

ref array<ECompartmentType> SCR_EditableVehicleUIInfo.m_aOccupantFillCompartmentTypes

protected

◆ m_bEditorPlaceAsOneGroup

bool SCR_EditableVehicleUIInfo.m_bEditorPlaceAsOneGroup

protected

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

Game/Editor/Containers/UIInfo/SCR_EditableVehicleUIInfo.c

Public Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ CanFillWithCrew()

◆ CanFillWithGivenTypes()

◆ CanFillWithPassengers()

◆ GetEditorPlaceAsOneGroup()

◆ GetFillBudgetCostsOfCrew()

◆ GetFillBudgetCostsOfPassengers()

◆ GetOccupantFillCompartmentTypes()

Member Data Documentation

◆ m_aOccupantFillCompartmentTypes

◆ m_bEditorPlaceAsOneGroup