Dragengine.Scenery.BehaviorPrepareStub Interface Reference

Interface for behaviors supporting preinitialization. More...

Public Member Functions
void	prepareStub (StubElement stub, GameWorld gameWorld, bool loading)
	Prepare stub. More...

Detailed Description

Interface for behaviors supporting preinitialization.

Version

1.17

Preinitializing allows behaviors to modify StubElement before Element.init() is called. This can be used to alter the behavior initialization procss my modifying the stub properties or textures.

Usually preinitializing is done for elements to be added to a game world. It is thus possible to use game world stub properties to alter the initialization. This can be used to adjust the behavior depending on what game world they are created for. It is also possible preinitialization is done without the element to be added to a specific game world. In this case gameWorld is null. Behaviors added for preinitializing have to be able to handle gameWorld being null.

Member Function Documentation

prepareStub()

void Dragengine.Scenery.BehaviorPrepareStub.prepareStub	(	StubElement	stub,
		GameWorld	gameWorld,
		bool	loading
	)

Prepare stub.

Called by BehaviorElementClass.createAndAddElement() with loading set to false and BehaviorElementClass.loadAndAddElement() with loading set to true.

---

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

• BehaviorPrepareStub.ds