Script entry for garbage system modding. More...

Inheritance diagram for SCR_GarbageSystem:

Static Public Member Functions
static SCR_GarbageSystem	GetByEntityWorld (IEntity entity)

Protected Member Functions
override float	OnInsertRequested (IEntity entity, float lifetime)

void	HandleVehicleResourcesChanged (SCR_ResourceContainer container)

SCR_ResourceContainer	FindVehicleResourceContainer (notnull IEntity entity, EResourceType resourceType)

Protected Member Functions inherited from GarbageSystem
bool	OnBeforeDelete (IEntity entity)

Static Protected Attributes
const float	RESOURCE_LIFETIME_PERCENTAGE = 0.25

Additional Inherited Members
Public Member Functions inherited from GarbageSystem
proto external bool	Insert (notnull IEntity entity, float lifetime=-1, bool ignoreBlacklist=false)
	Requests the garbage handling of the provided entity.

proto external bool	IsInserted (notnull IEntity entity)
	Check if the entity is tracked.

proto external bool	Withdraw (notnull IEntity entity)
	Removes the provided entity from the garbage system.

proto external bool	Bump (notnull IEntity entity, float additionalLifetime)
	Adds additional lifetime to the provided entity.

proto external float	GetLifetime (notnull IEntity entity)
	Returns the original lifetime the provided entity was inserted with.

proto external float	GetRemainingLifetime (notnull IEntity entity)
	Returns the remaining lifetime of the provided entity.

proto external void	Flush (float minTrackedSeconds=30)
	Forcefully disposes all entities that are tracked at least for x seconds.

proto external bool	UpdateBlacklist (notnull IEntity entity, bool blacklisted)
	Determine if the provided entity instance is blacklisted from being inserted.

proto external int	FetchTrackedEntities (notnull array< IEntity > entities)
	Fetch all entities tracked by the garbage system. Expensive operation. Use with care!

Public Member Functions inherited from GameSystem
bool	ShouldBePaused ()
	Is this system should be paused while the simulation is paused?

bool	ShouldBeEnabledInEditMode ()
	Is this system should be enabled inside the editor.

Detailed Description

Script entry for garbage system modding.

Member Function Documentation

SCR_ResourceContainer SCR_GarbageSystem.FindVehicleResourceContainer	(	notnull IEntity	entity,
		EResourceType	resourceType )

protected

static SCR_GarbageSystem SCR_GarbageSystem.GetByEntityWorld ( IEntity entity )

static

void SCR_GarbageSystem.HandleVehicleResourcesChanged ( SCR_ResourceContainer container )

protected

override float SCR_GarbageSystem.OnInsertRequested	(	IEntity	entity,
		float	lifetime )

protected

const float SCR_GarbageSystem.RESOURCE_LIFETIME_PERCENTAGE = 0.25

staticprotected

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