SCR_ResourceGeneratorActionDropContainers Interface Reference

Inheritance diagram for SCR_ResourceGeneratorActionDropContainers:

Public Member Functions
override bool	HasConstrainedGeneration ()
	Returns true if the action has constrainted generation of resources.
override float	ComputeGeneratedResources (notnull SCR_ResourceGenerator generator, float resourceValue)
	Returns the amount of possible generated resources.
override void	PerformAction (notnull SCR_ResourceGenerator generator, inout float resourceValue)
	Performs the action for generation of resources.

Static Public Member Functions
static ResourceName	GetDefaultPrefab ()

Protected Member Functions
SCR_ResourceContainer	SpawnContainer (notnull SCR_ResourceGenerator generator, inout float resourceValue)
	Spawns a container with a given resource value.
void	ProcessContainer (notnull SCR_ResourceContainer container, inout float resourceValue)
	Helper method to process a specific container of the list of container to perform the action on.

Protected Attributes
vector	m_vSpawnOrigin
float	m_fSpawnRadius
ResourceName	m_sResourceContainerPrefab

Member Function Documentation

ComputeGeneratedResources()

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

Returns the amount of possible generated resources.

Parameters

[in]	generator	The generator that the action is being computed on.
[in]	resourceValue	The resource value that is to be generated.

Implements SCR_ResourceGeneratorActionBase.

GetDefaultPrefab()

static ResourceName SCR_ResourceGeneratorActionDropContainers.GetDefaultPrefab ( )

static

Returns

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

HasConstrainedGeneration()

override bool SCR_ResourceGeneratorActionDropContainers.HasConstrainedGeneration

(

)

Returns true if the action has constrainted generation of resources.

Implements SCR_ResourceGeneratorActionBase.

PerformAction()

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

Performs the action for generation of resources.

Override this method in order to decide how to generate resources.

Parameters

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

Implements SCR_ResourceGeneratorActionBase.

ProcessContainer()

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

protected

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.

SpawnContainer()

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

protected

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.

Member Data Documentation

m_fSpawnRadius

float SCR_ResourceGeneratorActionDropContainers.m_fSpawnRadius

protected

m_sResourceContainerPrefab

ResourceName SCR_ResourceGeneratorActionDropContainers.m_sResourceContainerPrefab

protected

m_vSpawnOrigin

vector SCR_ResourceGeneratorActionDropContainers.m_vSpawnOrigin

protected

---

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

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