Component used to activate the sandbox resources functionality on an entity. More...

Inheritance diagram for SCR_ResourceComponent:

Public Member Functions
ScriptInvoker	TEMP_GetOnInteractorReplicated ()
	HOTFIX: Until replication issues are resolved.

void	TEMP_OnInteractorReplicated ()
	HOTFIX: Until replication issues are resolved.

bool	IsResourceTypeEnabled (EResourceType resourceType=EResourceType.SUPPLIES)

int	GetDisabledResourceTypes (inout notnull array< EResourceType > disabledResourceTypes)

bool	CanResourceTypeEnabledBeChanged (EResourceType resourceType=EResourceType.SUPPLIES)

void	SetResourceTypeEnabled (bool enable, EResourceType resourceType=EResourceType.SUPPLIES)
	Set Resource Type enabled or disabled.

ScriptInvokerBase< SCR_Resources_OnResourceEnabledChanged >	GetOnResourceTypeEnabledChanged ()

int	GetGridContainersBoundsMins ()

int	GetGridContainersBoundsMaxs ()

void	GetGridContainersBounds (out int mins, out int maxs)

void	GetGridContainersBoundingBox (out vector mins, out vector maxs)

void	GetGridContainersWorldBoundingBox (out vector mins, out vector maxs)

bool	IsDynamic ()

RplComponent	GetReplicationComponent ()

FactionAffiliationComponent	GetFactionAffiliationComponent ()

SCR_ResourceEncapsulator	GetEncapsulator (EResourceType resourceType)

bool	GetEncapsulator (EResourceType resourceType, out SCR_ResourceEncapsulator encapsulator)

array< SCR_ResourceEncapsulator >	GetEncapsulators ()

SCR_ResourceContainer	GetContainer (EResourceType resourceType)

bool	GetContainer (EResourceType resourceType, out SCR_ResourceContainer container)

array< SCR_ResourceContainer >	GetContainers ()

SCR_ResourceConsumer	GetConsumer (EResourceGeneratorID identifier, EResourceType resourceType)

bool	GetConsumer (EResourceGeneratorID identifier, EResourceType resourceType, inout SCR_ResourceConsumer consumer)

array< SCR_ResourceConsumer >	GetConsumers ()

SCR_ResourceGenerator	GetGenerator (EResourceGeneratorID identifier, EResourceType resourceType)

bool	GetGenerator (EResourceGeneratorID identifier, EResourceType resourceType, out SCR_ResourceGenerator generator)

array< SCR_ResourceGenerator >	GetGenerators ()

int	GetGridUpdateId ()

vector	GetLastPosition ()

bool	HasParent ()

Color	GetDebugColor ()

bool	IsGridUpdateIdGreaterThan (int gridUpdateId)

bool	IsDebugVisualizationEnabled ()

bool	IsVisible ()

bool	IsOwnerActive ()

void	SetGridUpdateId (int gridUpdateId)

void	SetIsVisible (bool state)

void	SetGridContainersBoundsMins (int mins)

void	SetGridContainersBoundsMaxs (int maxs)

void	SetGridContainersBounds (int mins, int maxs)

void	UpdateLastPosition ()
	Updates the serial number for the current processing call of the resource grid onto this component.

void	FlagForProcessing ()

void	UnflagForProcessing ()

void	DeleteConsumers ()

void	DeleteGenerators ()

void	DeleteQueryInteractors ()

void	Initialize (notnull IEntity owner)

void	Replicate ()

void	ReplicateEx ()
	Utility method used to replicate the component state.

override void	_WB_AfterWorldUpdate (IEntity owner, float timeSlice)
	Called after updating world in Workbench.

override bool	_WB_OnKeyChanged (IEntity owner, BaseContainer src, string key, BaseContainerList ownerContainers, IEntity parent)
	Any property value has been changed. You can use editor API here and do some additional edit actions which will be part of the same "key changed" action.

void	OnVisibilityChanged ()

void	OnVehiclePhysicsActive (IEntity owner, bool activeState)

Static Public Member Functions
static SCR_ResourceComponent	FindResourceComponent (IEntity entity, bool ignoreChildIfHasStorage=false)
	Use this function to obtain the Resource component instead of IEntity.FindComponent(SCR_ResourceComponent)

Static Public Attributes
const float	UPDATE_DISTANCE_TRESHOLD = 2.5

const float	UPDATE_DISTANCE_TRESHOLD_SQUARE = UPDATE_DISTANCE_TRESHOLD * UPDATE_DISTANCE_TRESHOLD

Protected Member Functions
void	OnResourceTypeEnabledChanged ()

bool	GetNextEncapsulatorCandidate (inout int position, inout int higherLimitPosition, inout SCR_ResourceEncapsulator encapsulator, EResourceType resourceType)

bool	GetNextContainerCandidate (inout int position, inout int higherLimitPosition, inout SCR_ResourceContainer container, EResourceType resourceType)

bool	GetNextConsumerCandidate (inout int position, inout int higherLimitPosition, inout SCR_ResourceConsumer consumer, EResourceGeneratorID identifier, EResourceType resourceType)

bool	GetNextGeneratorCandidate (inout int position, inout int higherLimitPosition, inout SCR_ResourceGenerator generator, EResourceGeneratorID identifier, EResourceType resourceType)

bool	ShouldConsumersBeReplicated ()

bool	ShouldGeneratorsBeReplicated ()

override void	OnPostInit (IEntity owner)
	Initialises the component, the consumer and/or the container.

override void	OnChildAdded (IEntity parent, IEntity child)
	Called on parent entity when child entity is added into hierarchy.

override void	EOnInit (IEntity owner)
	Event after entity is allocated and initialized.

void	DebugDraw ()
	Processes and presents the debugging visualization for the consumer and/or container.

override void	OnAddedToParent (IEntity child, IEntity parent)

void	OnAddedToParentEx (IEntity child, IEntity parent)

override void	OnRemovedFromParent (IEntity child, IEntity parent)

override void	OnDelete (IEntity owner)

Protected Attributes
bool	m_bIsDynamic

bool	m_bIsNetDirty

int	m_iGridUpdateId = int.MIN

int	m_iGridContainersBoundsMins = 0xFFFFFFFF

int	m_iGridContainersBoundsMaxs = 0xFFFFFFFF

vector	m_vGridContainersBoundingVolumeMins

vector	m_vGridContainersBoundingVolumeMaxs

bool	m_bIsFlaggedForProcessing

ref array< ref SCR_ResourceEncapsulator >	m_aEncapsulators
	Refer to SCR_ResourceEncapsulator for documentation.

ref array< ref SCR_ResourceConsumer >	m_aConsumers
	Refer to SCR_ResourceConsumer for documentation.

ref array< ref SCR_ResourceGenerator >	m_aGenerators
	Refer to SCR_ResourceGenerator for documentation.

ref array< EResourceType >	m_aDisabledResourceTypes

ref array< EResourceType >	m_aDisallowChangingEnableResource

ref ScriptInvoker	m_TEMP_OnInteractorReplicated
	HOTFIX: Until replication issues are resolved.

ref ScriptInvokerBase< SCR_Resources_OnResourceEnabledChanged >	m_OnResourceTypeEnabledChanged

bool	m_bEnableDebugVisualization
	Setting for enabling the debugging visualization of the container and/or consumer.

EResourceDebugVisualizationFlags	m_eDebugVisualizationFlags
	Flags for enabling the debugging visualization.

ref Color	m_DebugColor
	Setting for the base color for the debugging visualization of the container and/or consumer.

bool	m_bIsVisible = true

ref array< ref SCR_ResourceContainer >	m_aContainerInstances = {}
	Defined/Configured through SCR_ResourceComponentClass::m_Container.

RplComponent	m_ReplicationComponent
	Replication component attached to the owner entity.

FactionAffiliationComponent	m_FactionAffiliationComponent

vector	m_LastPosition = vector.Zero

bool	m_bHasParent

bool	m_bIsOwnerActive

bool	m_bIsInitialized

bool	m_bIsAddedToParentBuffered

Static Protected Attributes
const float	UPDATE_PERIOD = 10.0 / 60.0

Detailed Description

Component used to activate the sandbox resources functionality on an entity.

This component can enable the functionality for both sandbox container and sandbox consumer in an individual manner. The sandbox resources functionality does not require a manager so just the presence of containers being registered into a consumer's queue is enough for it to perform its functionality. The replication component is a requirement for the component to work properly.

Member Function Documentation

◆ _WB_AfterWorldUpdate()

override void SCR_ResourceComponent._WB_AfterWorldUpdate	(	IEntity	owner,
		float	timeSlice
	)

Called after updating world in Workbench.

The entity must be visible in frustum, selected or named. Used for performing the debug visualization on Workbench Editor's viewport.

Parameters

[in]	owner	Entity that owns this component.
[in]	timeSlice	Difference of the previous call of this method and the time of the current call.

◆ _WB_OnKeyChanged()

override bool SCR_ResourceComponent._WB_OnKeyChanged	(	IEntity	owner,
		BaseContainer	src,
		string	key,
		BaseContainerList	ownerContainers,
		IEntity	parent
	)

Any property value has been changed. You can use editor API here and do some additional edit actions which will be part of the same "key changed" action.

◆ CanResourceTypeEnabledBeChanged()

bool SCR_ResourceComponent.CanResourceTypeEnabledBeChanged ( EResourceType resourceType = EResourceType::SUPPLIES )

Parameters

[in] resourceType Type to check

Returns: If supplies are enabled or not (Only checked if global supplies are enabled, otherwise it always returns false)

◆ DebugDraw()

void SCR_ResourceComponent.DebugDraw ( )

protected

Processes and presents the debugging visualization for the consumer and/or container.

Generic/Shared visualization should be processed explicitely here and consumer specific visualiation should be processed through SCR_ResourceConsumer::DebugDraw(), similarly for the container with SCR_ResourceContainer::DebugDraw(). A white arrow is drawn explicitely from here with the intent of providing a visual cue of the extents of the highest range, that is the storage range of the container or the resource range of the consumer. Whatever is the highest is the height that will be selected for this arrow.

TODO: Cache the height value and only change it on a event basis.

Processes and presents the debugging visualization for the encapsulator.

Draws the arrow for the visual cue regarding the maximum range.

◆ DeleteConsumers()

void SCR_ResourceComponent.DeleteConsumers ( )

◆ DeleteGenerators()

void SCR_ResourceComponent.DeleteGenerators ( )

◆ DeleteQueryInteractors()

void SCR_ResourceComponent.DeleteQueryInteractors ( )

◆ EOnInit()

override void SCR_ResourceComponent.EOnInit ( IEntity owner )

protected

Event after entity is allocated and initialized.

Parameters

owner The owner entity

◆ FindResourceComponent()

static SCR_ResourceComponent SCR_ResourceComponent.FindResourceComponent	(	IEntity	entity,
		bool	ignoreChildIfHasStorage = `false`
	)

static

Use this function to obtain the Resource component instead of IEntity.FindComponent(SCR_ResourceComponent)

Parameters

[in]	entity	Entity to get Resource component from. Will loop through children in entity is a vehicle and no resource component was found on the entity
[in]	ignoreChildIfHasStorage	If looping through children and this is true than it will not return the ResourceComponent if that child has an inventory storage

Returns: Get ResourceComponent from given entity.

◆ FlagForProcessing()

void SCR_ResourceComponent.FlagForProcessing ( )

◆ GetConsumer() [1/2]

SCR_ResourceConsumer SCR_ResourceComponent.GetConsumer	(	EResourceGeneratorID	identifier,
		EResourceType	resourceType
	)

Parameters

[in]	identifier
[in]	resourceType

Returns: The first consumer instance of a specified resource type, or null if none.

◆ GetConsumer() [2/2]

bool SCR_ResourceComponent.GetConsumer	(	EResourceGeneratorID	identifier,
		EResourceType	resourceType,
		inout SCR_ResourceConsumer	consumer
	)

Parameters

[in]	identifier
[in]	resourceType
[in,out]	consumer	The first consumer instance of a specified resource type, or null if none.

Returns: If a consumer instance of a specified resource type has been found.

◆ GetConsumers()

array< SCR_ResourceConsumer > SCR_ResourceComponent.GetConsumers ( )

Returns: The consumer instances, or null if none.

◆ GetContainer() [1/2]

SCR_ResourceContainer SCR_ResourceComponent.GetContainer ( EResourceType resourceType )

Parameters

[in] resourceType

Returns: The first container instance of a specified resource type, or null if none.

◆ GetContainer() [2/2]

bool SCR_ResourceComponent.GetContainer	(	EResourceType	resourceType,
		out SCR_ResourceContainer	container
	)

Parameters

[in]	resourceType
[out]	container

Returns: If a container instance of a specified resource type has been found.

◆ GetContainers()

array< SCR_ResourceContainer > SCR_ResourceComponent.GetContainers ( )

Returns: The container instances, or null if none.

◆ GetDebugColor()

Color SCR_ResourceComponent.GetDebugColor ( )

Returns: The debug base color for the debugging visualization of the container and/or consumer.

◆ GetDisabledResourceTypes()

int SCR_ResourceComponent.GetDisabledResourceTypes ( inout notnull array< EResourceType > disabledResourceTypes )

Parameters

[in] disabledResourceTypes List of disabled resources

Returns: Count of all disabled resource types

◆ GetEncapsulator() [1/2]

SCR_ResourceEncapsulator SCR_ResourceComponent.GetEncapsulator ( EResourceType resourceType )

Parameters

[in] resourceType

Returns: The first encapsulator instance of a specified resource type, or null if none.

◆ GetEncapsulator() [2/2]

bool SCR_ResourceComponent.GetEncapsulator	(	EResourceType	resourceType,
		out SCR_ResourceEncapsulator	encapsulator
	)

Parameters

[in]	resourceType
[out]	encapsulator	The first encapsulator instance of a specified resource type, or null if none.

Returns: If a encapsulator instance of a specified resource type has been found.

◆ GetEncapsulators()

array< SCR_ResourceEncapsulator > SCR_ResourceComponent.GetEncapsulators ( )

Returns: The encapsulator instances, or null if none.

◆ GetFactionAffiliationComponent()

FactionAffiliationComponent SCR_ResourceComponent.GetFactionAffiliationComponent ( )

Returns

◆ GetGenerator() [1/2]

SCR_ResourceGenerator SCR_ResourceComponent.GetGenerator	(	EResourceGeneratorID	identifier,
		EResourceType	resourceType
	)

Parameters

[in]	identifier
[in]	resourceType

Returns: The first generator instance of a specified resource type, or null if none.

◆ GetGenerator() [2/2]

bool SCR_ResourceComponent.GetGenerator	(	EResourceGeneratorID	identifier,
		EResourceType	resourceType,
		out SCR_ResourceGenerator	generator
	)

Parameters

[in]	identifier
[in]	resourceType
[out]	generator	The first generator instance of a specified resource type, or null if none.

Returns: If a generator instance of a specified resource type has been found.

◆ GetGenerators()

array< SCR_ResourceGenerator > SCR_ResourceComponent.GetGenerators ( )

Returns: The generator instances, or null if none.

◆ GetGridContainersBoundingBox()

void SCR_ResourceComponent.GetGridContainersBoundingBox	(	out vector	mins,
		out vector	maxs
	)

Parameters

[out]	mins
[out]	maxs

◆ GetGridContainersBounds()

void SCR_ResourceComponent.GetGridContainersBounds	(	out int	mins,
		out int	maxs
	)

Parameters

[out]	mins
[out]	maxs

◆ GetGridContainersBoundsMaxs()

int SCR_ResourceComponent.GetGridContainersBoundsMaxs ( )

Returns

◆ GetGridContainersBoundsMins()

int SCR_ResourceComponent.GetGridContainersBoundsMins ( )

Returns

◆ GetGridContainersWorldBoundingBox()

void SCR_ResourceComponent.GetGridContainersWorldBoundingBox	(	out vector	mins,
		out vector	maxs
	)

Parameters

[out]	mins
[out]	maxs

◆ GetGridUpdateId()

int SCR_ResourceComponent.GetGridUpdateId ( )

Returns

◆ GetLastPosition()

vector SCR_ResourceComponent.GetLastPosition ( )

Returns: The last processed world position of the component.

◆ GetNextConsumerCandidate()

bool SCR_ResourceComponent.GetNextConsumerCandidate	(	inout int	position,
		inout int	higherLimitPosition,
		inout SCR_ResourceConsumer	consumer,
		EResourceGeneratorID	identifier,
		EResourceType	resourceType
	)

protected

◆ GetNextContainerCandidate()

bool SCR_ResourceComponent.GetNextContainerCandidate	(	inout int	position,
		inout int	higherLimitPosition,
		inout SCR_ResourceContainer	container,
		EResourceType	resourceType
	)

protected

◆ GetNextEncapsulatorCandidate()

bool SCR_ResourceComponent.GetNextEncapsulatorCandidate	(	inout int	position,
		inout int	higherLimitPosition,
		inout SCR_ResourceEncapsulator	encapsulator,
		EResourceType	resourceType
	)

protected

◆ GetNextGeneratorCandidate()

bool SCR_ResourceComponent.GetNextGeneratorCandidate	(	inout int	position,
		inout int	higherLimitPosition,
		inout SCR_ResourceGenerator	generator,
		EResourceGeneratorID	identifier,
		EResourceType	resourceType
	)

protected

◆ GetOnResourceTypeEnabledChanged()

ScriptInvokerBase< SCR_Resources_OnResourceEnabledChanged > SCR_ResourceComponent.GetOnResourceTypeEnabledChanged ( )

Returns: ScriptInvoker OnSupplies Enabled

◆ GetReplicationComponent()

RplComponent SCR_ResourceComponent.GetReplicationComponent ( )

Returns

◆ HasParent()

bool SCR_ResourceComponent.HasParent ( )

Returns: true if the owner has a parent entity, false otherwise.

◆ Initialize()

void SCR_ResourceComponent.Initialize ( notnull IEntity owner )

Parameters

[in] owner

◆ IsDebugVisualizationEnabled()

bool SCR_ResourceComponent.IsDebugVisualizationEnabled ( )

Returns: true if the debugging visualization of the container and/or consumer is enabled, false oherwise.

◆ IsDynamic()

bool SCR_ResourceComponent.IsDynamic ( )

Returns

◆ IsGridUpdateIdGreaterThan()

bool SCR_ResourceComponent.IsGridUpdateIdGreaterThan ( int gridUpdateId )

Parameters

[in] gridUpdateId

Returns

◆ IsOwnerActive()

bool SCR_ResourceComponent.IsOwnerActive ( )

Returns

◆ IsResourceTypeEnabled()

bool SCR_ResourceComponent.IsResourceTypeEnabled ( EResourceType resourceType = EResourceType::SUPPLIES )

Parameters

[in] resourceType Type to check

Returns: If supplies are enabled or not (Only checked if global supplies are enabled, otherwise it always returns false)

◆ IsVisible()

bool SCR_ResourceComponent.IsVisible ( )

Returns

◆ OnAddedToParent()

override void SCR_ResourceComponent.OnAddedToParent	(	IEntity	child,
		IEntity	parent
	)

protected

◆ OnAddedToParentEx()

void SCR_ResourceComponent.OnAddedToParentEx	(	IEntity	child,
		IEntity	parent
	)

protected

◆ OnChildAdded()

override void SCR_ResourceComponent.OnChildAdded	(	IEntity	parent,
		IEntity	child
	)

protected

Called on parent entity when child entity is added into hierarchy.

Parameters

[in]	parent
[in]	child

◆ OnDelete()

override void SCR_ResourceComponent.OnDelete ( IEntity owner )

protected

◆ OnPostInit()

override void SCR_ResourceComponent.OnPostInit ( IEntity owner )

protected

Initialises the component, the consumer and/or the container.

Event called after init when all components are initialised.

Parameters

[in] owner Entity that owns this component.

◆ OnRemovedFromParent()

override void SCR_ResourceComponent.OnRemovedFromParent	(	IEntity	child,
		IEntity	parent
	)

protected

◆ OnResourceTypeEnabledChanged()

void SCR_ResourceComponent.OnResourceTypeEnabledChanged ( )

protected

◆ OnVehiclePhysicsActive()

void SCR_ResourceComponent.OnVehiclePhysicsActive	(	IEntity	owner,
		bool	activeState
	)

Parameters

[in]	owner
[in]	activeState

◆ OnVisibilityChanged()

void SCR_ResourceComponent.OnVisibilityChanged ( )

◆ Replicate()

void SCR_ResourceComponent.Replicate ( )

◆ ReplicateEx()

void SCR_ResourceComponent.ReplicateEx ( )

Utility method used to replicate the component state.

Warning: This is important for the SCR_ResourceConsumer and SCR_ResourceContainer classes as it is used to cause the component to replicate, so do not add extra functionality here unless it is necessary for the replication functionality of both the SCR_ResourceConsumer and SCR_ResourceContainer classes.

◆ SetGridContainersBounds()

void SCR_ResourceComponent.SetGridContainersBounds	(	int	mins,
		int	maxs
	)

Parameters

[in]	mins
[in]	maxs

◆ SetGridContainersBoundsMaxs()

void SCR_ResourceComponent.SetGridContainersBoundsMaxs ( int maxs )

Parameters

[in] maxs

◆ SetGridContainersBoundsMins()

void SCR_ResourceComponent.SetGridContainersBoundsMins ( int mins )

Parameters

[in] mins

◆ SetGridUpdateId()

void SCR_ResourceComponent.SetGridUpdateId ( int gridUpdateId )

Parameters

[in] gridUpdateId

◆ SetIsVisible()

void SCR_ResourceComponent.SetIsVisible ( bool state )

Parameters

[in] state

◆ SetResourceTypeEnabled()

void SCR_ResourceComponent.SetResourceTypeEnabled	(	bool	enable,
		EResourceType	resourceType = `EResourceType::SUPPLIES`
	)

Set Resource Type enabled or disabled.

Parameters

[in]	enable	Set true to enable resource type, set false to disable
[in]	resourceType	Resource type to enable/disable

◆ ShouldConsumersBeReplicated()

bool SCR_ResourceComponent.ShouldConsumersBeReplicated ( )

protected

◆ ShouldGeneratorsBeReplicated()

bool SCR_ResourceComponent.ShouldGeneratorsBeReplicated ( )

protected

◆ TEMP_GetOnInteractorReplicated()

ScriptInvoker SCR_ResourceComponent.TEMP_GetOnInteractorReplicated ( )

HOTFIX: Until replication issues are resolved.

◆ TEMP_OnInteractorReplicated()

void SCR_ResourceComponent.TEMP_OnInteractorReplicated ( )

HOTFIX: Until replication issues are resolved.

◆ UnflagForProcessing()

void SCR_ResourceComponent.UnflagForProcessing ( )

◆ UpdateLastPosition()

void SCR_ResourceComponent.UpdateLastPosition ( )

Updates the serial number for the current processing call of the resource grid onto this component.

Member Data Documentation

◆ m_aConsumers

ref array<ref SCR_ResourceConsumer> SCR_ResourceComponent.m_aConsumers

protected

Refer to SCR_ResourceConsumer for documentation.

◆ m_aContainerInstances

ref array<ref SCR_ResourceContainer> SCR_ResourceComponent.m_aContainerInstances = {}

protected

Defined/Configured through SCR_ResourceComponentClass::m_Container.

Refer to SCR_ResourceContainer for documentation.

◆ m_aDisabledResourceTypes

ref array<EResourceType> SCR_ResourceComponent.m_aDisabledResourceTypes

protected

◆ m_aDisallowChangingEnableResource

ref array<EResourceType> SCR_ResourceComponent.m_aDisallowChangingEnableResource

protected

◆ m_aEncapsulators

ref array<ref SCR_ResourceEncapsulator> SCR_ResourceComponent.m_aEncapsulators

protected

Refer to SCR_ResourceEncapsulator for documentation.

◆ m_aGenerators

ref array<ref SCR_ResourceGenerator> SCR_ResourceComponent.m_aGenerators

protected

Refer to SCR_ResourceGenerator for documentation.

◆ m_bEnableDebugVisualization

bool SCR_ResourceComponent.m_bEnableDebugVisualization

protected

Setting for enabling the debugging visualization of the container and/or consumer.

◆ m_bHasParent

bool SCR_ResourceComponent.m_bHasParent

protected

◆ m_bIsAddedToParentBuffered

bool SCR_ResourceComponent.m_bIsAddedToParentBuffered

protected

◆ m_bIsDynamic

bool SCR_ResourceComponent.m_bIsDynamic

protected

◆ m_bIsFlaggedForProcessing

bool SCR_ResourceComponent.m_bIsFlaggedForProcessing

protected

◆ m_bIsInitialized

bool SCR_ResourceComponent.m_bIsInitialized

protected

◆ m_bIsNetDirty

bool SCR_ResourceComponent.m_bIsNetDirty

protected

◆ m_bIsOwnerActive

bool SCR_ResourceComponent.m_bIsOwnerActive

protected

◆ m_bIsVisible

bool SCR_ResourceComponent.m_bIsVisible = true

protected

◆ m_DebugColor

ref Color SCR_ResourceComponent.m_DebugColor

protected

Setting for the base color for the debugging visualization of the container and/or consumer.

◆ m_eDebugVisualizationFlags

EResourceDebugVisualizationFlags SCR_ResourceComponent.m_eDebugVisualizationFlags

protected

Flags for enabling the debugging visualization.

◆ m_FactionAffiliationComponent

FactionAffiliationComponent SCR_ResourceComponent.m_FactionAffiliationComponent

protected

◆ m_iGridContainersBoundsMaxs

int SCR_ResourceComponent.m_iGridContainersBoundsMaxs = 0xFFFFFFFF

protected

◆ m_iGridContainersBoundsMins

int SCR_ResourceComponent.m_iGridContainersBoundsMins = 0xFFFFFFFF

protected

◆ m_iGridUpdateId

int SCR_ResourceComponent.m_iGridUpdateId = int.MIN

protected

◆ m_LastPosition

vector SCR_ResourceComponent.m_LastPosition = vector.Zero

protected

◆ m_OnResourceTypeEnabledChanged

ref ScriptInvokerBase<SCR_Resources_OnResourceEnabledChanged> SCR_ResourceComponent.m_OnResourceTypeEnabledChanged

protected

◆ m_ReplicationComponent

RplComponent SCR_ResourceComponent.m_ReplicationComponent

protected

Replication component attached to the owner entity.

◆ m_TEMP_OnInteractorReplicated

ref ScriptInvoker SCR_ResourceComponent.m_TEMP_OnInteractorReplicated

protected

HOTFIX: Until replication issues are resolved.

◆ m_vGridContainersBoundingVolumeMaxs

vector SCR_ResourceComponent.m_vGridContainersBoundingVolumeMaxs

protected

◆ m_vGridContainersBoundingVolumeMins

vector SCR_ResourceComponent.m_vGridContainersBoundingVolumeMins

protected

◆ UPDATE_DISTANCE_TRESHOLD

const float SCR_ResourceComponent.UPDATE_DISTANCE_TRESHOLD = 2.5

static

◆ UPDATE_DISTANCE_TRESHOLD_SQUARE

const float SCR_ResourceComponent.UPDATE_DISTANCE_TRESHOLD_SQUARE = UPDATE_DISTANCE_TRESHOLD * UPDATE_DISTANCE_TRESHOLD

static

◆ UPDATE_PERIOD

const float SCR_ResourceComponent.UPDATE_PERIOD = 10.0 / 60.0

staticprotected

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

Game/Sandbox/Resources/SCR_ResourceComponent.c

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ _WB_AfterWorldUpdate()

◆ _WB_OnKeyChanged()

◆ CanResourceTypeEnabledBeChanged()

◆ DebugDraw()

◆ DeleteConsumers()

◆ DeleteGenerators()

◆ DeleteQueryInteractors()

◆ EOnInit()

◆ FindResourceComponent()

◆ FlagForProcessing()

◆ GetConsumer() [1/2]

◆ GetConsumer() [2/2]

◆ GetConsumers()

◆ GetContainer() [1/2]

◆ GetContainer() [2/2]

◆ GetContainers()

◆ GetDebugColor()

◆ GetDisabledResourceTypes()

◆ GetEncapsulator() [1/2]

◆ GetEncapsulator() [2/2]

◆ GetEncapsulators()

◆ GetFactionAffiliationComponent()

◆ GetGenerator() [1/2]

◆ GetGenerator() [2/2]

◆ GetGenerators()

◆ GetGridContainersBoundingBox()

◆ GetGridContainersBounds()

◆ GetGridContainersBoundsMaxs()

◆ GetGridContainersBoundsMins()

◆ GetGridContainersWorldBoundingBox()

◆ GetGridUpdateId()

◆ GetLastPosition()

◆ GetNextConsumerCandidate()

◆ GetNextContainerCandidate()

◆ GetNextEncapsulatorCandidate()

◆ GetNextGeneratorCandidate()

◆ GetOnResourceTypeEnabledChanged()

◆ GetReplicationComponent()

◆ HasParent()

◆ Initialize()

◆ IsDebugVisualizationEnabled()

◆ IsDynamic()

◆ IsGridUpdateIdGreaterThan()

◆ IsOwnerActive()

◆ IsResourceTypeEnabled()

◆ IsVisible()

◆ OnAddedToParent()

◆ OnAddedToParentEx()

◆ OnChildAdded()

◆ OnDelete()

◆ OnPostInit()

◆ OnRemovedFromParent()

◆ OnResourceTypeEnabledChanged()

◆ OnVehiclePhysicsActive()

◆ OnVisibilityChanged()

◆ Replicate()

◆ ReplicateEx()

◆ SetGridContainersBounds()

◆ SetGridContainersBoundsMaxs()

◆ SetGridContainersBoundsMins()

◆ SetGridUpdateId()

◆ SetIsVisible()

◆ SetResourceTypeEnabled()

◆ ShouldConsumersBeReplicated()

◆ ShouldGeneratorsBeReplicated()

◆ TEMP_GetOnInteractorReplicated()

◆ TEMP_OnInteractorReplicated()

◆ UnflagForProcessing()

◆ UpdateLastPosition()

Member Data Documentation

◆ m_aConsumers

◆ m_aContainerInstances