Observer interface for hooking into generation lifecycle events. More...

#include <entitygen.hpp>

Inheritance diagram for dasmig::generation_observer:

Public Member Functions
	generation_observer ()=default
	Default constructor.

	generation_observer (const generation_observer &)=default
	Copyable.

generation_observer &	operator= (const generation_observer &)=default
	Copyable.

	generation_observer (generation_observer &&) noexcept=default
	Movable.

generation_observer &	operator= (generation_observer &&) noexcept=default
	Movable.

virtual	~generation_observer ()=default
	Virtual destructor.

Entity Lifecycle
virtual void	on_before_generate ()
	Called before an entity is generated.

virtual void	on_after_generate (const entity &e)
	Called after an entity is successfully generated.

Component Generation
virtual void	on_before_component (const std::wstring &key)
	Called before a component is generated.

virtual void	on_after_component (const std::wstring &key, const std::any &value)
	Called after a component is successfully generated.

Component Skip
virtual void	on_skip (const std::wstring &key)
	Called when a component is skipped (weight roll or conditional exclusion).

Component Validation
virtual void	on_before_retry (const std::wstring &key, std::size_t attempt)
	Called before a component validation retry.

virtual void	on_after_retry (const std::wstring &key, std::size_t attempt, const std::any &value)
	Called after a component validation retry.

virtual void	on_component_fail (const std::wstring &key)
	Called when component validation is exhausted (precedes exception).

Entity Validation
virtual void	on_before_entity_retry (std::size_t attempt)
	Called before an entity validation retry.

virtual void	on_after_entity_retry (std::size_t attempt)
	Called after an entity validation retry.

virtual void	on_entity_fail ()
	Called when entity validation is exhausted (precedes exception).

Component Registration
virtual void	on_before_add (const std::wstring &key)
	Called before a component is registered.

virtual void	on_after_add (const std::wstring &key)
	Called after a component is registered.

virtual void	on_before_remove (const std::wstring &key)
	Called before a component is removed.

virtual void	on_after_remove (const std::wstring &key)
	Called after a component is removed.

Detailed Description

Observer interface for hooking into generation lifecycle events.

Override only the methods you care about; all default to no-ops. Multiple observers can be attached to a generator via eg::add_observer().

See also: eg::add_observer(), dasmig::ext::stats_observer

Definition at line 1119 of file entitygen.hpp.

Member Function Documentation

◆ on_after_add()

virtual void dasmig::generation_observer::on_after_add ( const std::wstring & key )

inlinevirtual

Called after a component is registered.

Parameters

key	The component key that was added.

Definition at line 1205 of file entitygen.hpp.

◆ on_after_component()

virtual void dasmig::generation_observer::on_after_component	(	const std::wstring &	key,
		const std::any &	value
	)

inlinevirtual

Called after a component is successfully generated.

Parameters

key	The component key.
value	The generated value.

Reimplemented in dasmig::ext::stats_observer.

Definition at line 1150 of file entitygen.hpp.

◆ on_after_entity_retry()

virtual void dasmig::generation_observer::on_after_entity_retry ( std::size_t attempt )

inlinevirtual

Called after an entity validation retry.

Parameters

attempt The entity retry attempt number.

Reimplemented in dasmig::ext::stats_observer.

Definition at line 1191 of file entitygen.hpp.

◆ on_after_generate()

virtual void dasmig::generation_observer::on_after_generate ( const entity & e )

inlinevirtual

Called after an entity is successfully generated.

Parameters

e	The generated entity.

Reimplemented in dasmig::ext::stats_observer.

Definition at line 1138 of file entitygen.hpp.

◆ on_after_remove()

virtual void dasmig::generation_observer::on_after_remove ( const std::wstring & key )

inlinevirtual

Called after a component is removed.

Parameters

key	The component key that was removed.

Definition at line 1212 of file entitygen.hpp.

◆ on_after_retry()

virtual void dasmig::generation_observer::on_after_retry	(	const std::wstring &	key,
		std::size_t	attempt,
		const std::any &	value
	)

inlinevirtual

Called after a component validation retry.

Parameters

key	The component key.
attempt	The retry attempt number.
value	The newly generated value.

Reimplemented in dasmig::ext::stats_observer.

Definition at line 1174 of file entitygen.hpp.

◆ on_before_add()

virtual void dasmig::generation_observer::on_before_add ( const std::wstring & key )

inlinevirtual

Called before a component is registered.

Parameters

key	The component key being added.

Definition at line 1202 of file entitygen.hpp.

◆ on_before_component()

virtual void dasmig::generation_observer::on_before_component ( const std::wstring & key )

inlinevirtual

Called before a component is generated.

Parameters

key	The component key about to be generated.

Reimplemented in dasmig::ext::stats_observer.

Definition at line 1146 of file entitygen.hpp.

◆ on_before_entity_retry()

virtual void dasmig::generation_observer::on_before_entity_retry ( std::size_t attempt )

inlinevirtual

Called before an entity validation retry.

Parameters

attempt The entity retry attempt number (1-based).

Definition at line 1188 of file entitygen.hpp.

◆ on_before_generate()

virtual void dasmig::generation_observer::on_before_generate ( )

inlinevirtual

Called before an entity is generated.

Reimplemented in dasmig::ext::stats_observer.

Definition at line 1135 of file entitygen.hpp.

◆ on_before_remove()

virtual void dasmig::generation_observer::on_before_remove ( const std::wstring & key )

inlinevirtual

Called before a component is removed.

Parameters

key	The component key being removed.

Definition at line 1209 of file entitygen.hpp.

◆ on_before_retry()

virtual void dasmig::generation_observer::on_before_retry	(	const std::wstring &	key,
		std::size_t	attempt
	)

inlinevirtual

Called before a component validation retry.

Parameters

key	The component key being retried.
attempt	The retry attempt number (1-based).

Definition at line 1168 of file entitygen.hpp.

◆ on_component_fail()

virtual void dasmig::generation_observer::on_component_fail ( const std::wstring & key )

inlinevirtual

Called when component validation is exhausted (precedes exception).

Parameters

key	The failed component key.

Reimplemented in dasmig::ext::stats_observer.

Definition at line 1180 of file entitygen.hpp.

◆ on_entity_fail()

virtual void dasmig::generation_observer::on_entity_fail ( )

inlinevirtual

Called when entity validation is exhausted (precedes exception).

Reimplemented in dasmig::ext::stats_observer.

Definition at line 1194 of file entitygen.hpp.

◆ on_skip()

virtual void dasmig::generation_observer::on_skip ( const std::wstring & key )

inlinevirtual

Called when a component is skipped (weight roll or conditional exclusion).

Parameters

key	The skipped component key.

Reimplemented in dasmig::ext::stats_observer.

Definition at line 1159 of file entitygen.hpp.

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

dasmig/entitygen.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ on_after_add()

◆ on_after_component()

◆ on_after_entity_retry()

◆ on_after_generate()

◆ on_after_remove()

◆ on_after_retry()

◆ on_before_add()

◆ on_before_component()

◆ on_before_entity_retry()

◆ on_before_generate()

◆ on_before_remove()

◆ on_before_retry()

◆ on_component_fail()

◆ on_entity_fail()

◆ on_skip()