Open 3D Engine LmbrCentral Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
LmbrCentral::RandomTimedSpawnerComponentRequests Class Referenceabstract

Inherits AZ::ComponentBus.

Public Member Functions

virtual void Enable ()=0
 Starts random spawning.
 
virtual void Disable ()=0
 Stops random spawning.
 
virtual void Toggle ()=0
 Toggles random spawning.
 
virtual bool IsEnabled ()=0
 
virtual void SetRandomDistribution (AZ::RandomDistributionType randomDistribution)=0
 
virtual AZ::RandomDistributionType GetRandomDistribution ()=0
 
virtual void SetSpawnDelay (double spawnDelay)=0
 
virtual double GetSpawnDelay ()=0
 
virtual void SetSpawnDelayVariation (double spawnDelayVariation)=0
 
virtual double GetSpawnDelayVariation ()=0
 

Member Function Documentation

◆ GetRandomDistribution()

virtual AZ::RandomDistributionType LmbrCentral::RandomTimedSpawnerComponentRequests::GetRandomDistribution ( )
pure virtual

Gets the type of random distribution used for determining entity spawn location.

Returns
The AZ::RandomDistributionType currently in use for spawning

◆ GetSpawnDelay()

virtual double LmbrCentral::RandomTimedSpawnerComponentRequests::GetSpawnDelay ( )
pure virtual

Gets the time (in seconds) between entity spawns

Returns
The time between entity spawns

◆ GetSpawnDelayVariation()

virtual double LmbrCentral::RandomTimedSpawnerComponentRequests::GetSpawnDelayVariation ( )
pure virtual

Gets the random variation in spawn delay (time in seconds)

Returns
The random variation in spawn delay

◆ IsEnabled()

virtual bool LmbrCentral::RandomTimedSpawnerComponentRequests::IsEnabled ( )
pure virtual

Gets whether or not the component is spawning

Returns
True if the component is spawning

◆ SetRandomDistribution()

virtual void LmbrCentral::RandomTimedSpawnerComponentRequests::SetRandomDistribution ( AZ::RandomDistributionType  randomDistribution)
pure virtual

Sets the type of random distribution to use when determining where to place spawned entities.

@randomDistribution The mathematical random distribution to use for spawning

◆ SetSpawnDelay()

virtual void LmbrCentral::RandomTimedSpawnerComponentRequests::SetSpawnDelay ( double  spawnDelay)
pure virtual

Sets the time (in seconds) between entity spawns

Parameters
spawnDelayThe time between entity spawns

◆ SetSpawnDelayVariation()

virtual void LmbrCentral::RandomTimedSpawnerComponentRequests::SetSpawnDelayVariation ( double  spawnDelayVariation)
pure virtual

Sets the random variation in spawn delay (time in seconds)

This value is used to calculate a random value that is added onto the SpawnDelay parameter. The range of random values is between -SpawnDelayVariation and SpawnDelayVariation.

Parameters
spawnDelayVariationThe random variation applied to the spawn delay
The documentation for this class was generated from the following file: