Initialise Method (Int32, Single)

Project Mercury API

[This is preliminary documentation and is subject to change.]

Initialises the Emitter.

Namespace:  ProjectMercury.Emitters
Assembly:  ProjectMercury (in ProjectMercury.dll) Version: 3.1.0.0

Syntax

C#
public void Initialise(
	int budget,
	float term
)
Visual Basic (Declaration)
Public Sub Initialise ( _
	budget As Integer, _
	term As Single _
)
Visual C++
public:
void Initialise(
	int budget, 
	float term
)

Parameters

budget
Type: System..::.Int32
The number of Particles which are available to the Emitter.
term
Type: System..::.Single
The length of time that released Particles will remain active, in whole and fractional seconds.

Exceptions

ExceptionCondition
System..::.ArgumentExceptionThrown if the budget parameter is less than one, or if the term paramter is not a positive value.

See Also