SCR_ResourceGeneratorActionDropContainers Class Reference

Inheritance diagram for SCR_ResourceGeneratorActionDropContainers:

Protected Member Functions
override bool	HasConstrainedGeneration ()
override float	ComputeGeneratedResources (notnull SCR_ResourceGenerator generator, float resourceValue)
SCR_ResourceContainer	SpawnContainer (notnull SCR_ResourceGenerator generator, inout float resourceValue)
void	ProcessContainer (notnull SCR_ResourceContainer container, inout float resourceValue)
override void	PerformAction (notnull SCR_ResourceGenerator generator, inout float resourceValue)

Static Protected Member Functions
static ResourceName	GetDefaultPrefab ()

Protected Attributes
vector	m_vSpawnOrigin
float	m_fSpawnRadius
ResourceName	m_sResourceContainerPrefab

Detailed Description

Definition at line 2 of file SCR_ResourceGeneratorActionDropContainers.c.

Member Function Documentation

ComputeGeneratedResources()

override float SCR_ResourceGeneratorActionDropContainers::ComputeGeneratedResources ( notnull SCR_ResourceGenerator generator, float resourceValue )

inlineprotected

Definition at line 27 of file SCR_ResourceGeneratorActionDropContainers.c.

GetDefaultPrefab()

ResourceName SCR_ResourceGeneratorActionDropContainers::GetDefaultPrefab ( )

inlinestaticprotected

Returns

The default prefab name for the container to spawn for the action.

Definition at line 15 of file SCR_ResourceGeneratorActionDropContainers.c.

HasConstrainedGeneration()

override bool SCR_ResourceGeneratorActionDropContainers::HasConstrainedGeneration ( )

inlineprotected

Definition at line 21 of file SCR_ResourceGeneratorActionDropContainers.c.

PerformAction()

override void SCR_ResourceGeneratorActionDropContainers::PerformAction ( notnull SCR_ResourceGenerator generator, inout float resourceValue )

inlineprotected

Definition at line 102 of file SCR_ResourceGeneratorActionDropContainers.c.

ProcessContainer()

void SCR_ResourceGeneratorActionDropContainers::ProcessContainer ( notnull SCR_ResourceContainer container, inout float resourceValue )

inlineprotected

Helper method to process a specific container of the list of container to perform the action on.

Parameters

[in]	generator	The container that the action is being performed on.
[in,out]	resourceValue	The resource value that is to be used with the action.

Definition at line 94 of file SCR_ResourceGeneratorActionDropContainers.c.

SpawnContainer()

SCR_ResourceContainer SCR_ResourceGeneratorActionDropContainers::SpawnContainer ( notnull SCR_ResourceGenerator generator, inout float resourceValue )

inlineprotected

Spawns a container with a given resource value. The resource value will be of course clamped to the limits of the container configuration that was selected.

Parameters

[in]	generator	The generator that caused the action.
[in,out]	resourceValue	The resource value that is expected for the container to have.

Returns

The created container, if any otherwise null.

Definition at line 39 of file SCR_ResourceGeneratorActionDropContainers.c.

Member Data Documentation

m_fSpawnRadius

float SCR_ResourceGeneratorActionDropContainers::m_fSpawnRadius

protected

Definition at line 8 of file SCR_ResourceGeneratorActionDropContainers.c.

m_sResourceContainerPrefab

ResourceName SCR_ResourceGeneratorActionDropContainers::m_sResourceContainerPrefab

protected

Definition at line 11 of file SCR_ResourceGeneratorActionDropContainers.c.

m_vSpawnOrigin

vector SCR_ResourceGeneratorActionDropContainers::m_vSpawnOrigin

protected

Definition at line 5 of file SCR_ResourceGeneratorActionDropContainers.c.

---

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

• scripts/Game/Sandbox/Resources/Generator/Actions/SCR_ResourceGeneratorActionDropContainers.c