PrefabService Class Reference

Global service for managing prefab factories and component creation. More...

#include <prefab_service.h>

Inheritance diagram for PrefabService:

Public Member Functions
	PrefabService ()=default
	PrefabService (const PrefabService &)=delete
PrefabService &	operator= (const PrefabService &)=delete
	PrefabService (PrefabService &&)=delete
PrefabService &	operator= (PrefabService &&)=delete
void	register_prefab (const std::string &prefab_type_id, const PrefabFactory &factory)
	Register a prefab factory for a given type ID.
void	unregister_prefab (const std::string &prefab_type_id)
	Unregister a previously registered prefab factory.
bool	has_prefab (const std::string &prefab_type_id) const
	Check if a prefab type is registered.
std::reference_wrapper< GameObject >	instantiate (const std::string &prefab_type_id, Scene &scene, const std::string &name)
	Instantiate a GameObject from a registered prefab.
std::vector< std::string >	get_registered_prefabs () const
	Get all registered prefab type IDs.
void	clear_all ()
	Clear all registered prefabs.
Public Member Functions inherited from IEngineService
virtual	~IEngineService ()=default

Detailed Description

Global service for managing prefab factories and component creation.

This is a singleton that maintains a mapping of prefab type IDs to factory functions. When a network snapshot arrives with an object of an unknown type, the service can instantiate it with the correct components.

Usage:

• Register prefab factories with unique type IDs using register_prefab().
• Instantiate GameObjects from prefabs using instantiate().
• Check for registered prefabs with has_prefab().
• Unregister prefabs with unregister_prefab().
• Retrieve all registered prefab type IDs with get_registered_prefabs().
• Clear all registered prefabs with clear_all().

  Note

  Prefab factories should create and return GameObjects with all necessary components attached.

Constructor & Destructor Documentation

PrefabService() [1/3]

PrefabService::PrefabService ( )

default

PrefabService() [2/3]

PrefabService::PrefabService ( const PrefabService &  )

delete

PrefabService() [3/3]

PrefabService::PrefabService ( PrefabService &&  )

delete

Member Function Documentation

clear_all()

void PrefabService::clear_all

(

)

Clear all registered prefabs.

get_registered_prefabs()

std::vector< std::string > PrefabService::get_registered_prefabs

(

)

const

Get all registered prefab type IDs.

has_prefab()

bool PrefabService::has_prefab

(

const std::string &

prefab_type_id

)

const

Check if a prefab type is registered.

Parameters

prefab_type_id

Identifier to check

Returns

True if registered, false otherwise

instantiate()

std::reference_wrapper< GameObject > PrefabService::instantiate	(	const std::string &	prefab_type_id,
		Scene &	scene,
		const std::string &	name
	)

Instantiate a GameObject from a registered prefab.

Parameters

prefab_type_id	Type ID of the prefab to instantiate
scene	Scene to add the object to
name	Name to assign to the created GameObject

Returns

Reference to the created GameObject

Exceptions

std::runtime_error

if prefab_type_id is not registered

operator=() [1/2]

PrefabService & PrefabService::operator= ( const PrefabService &  )

delete

operator=() [2/2]

PrefabService & PrefabService::operator= ( PrefabService &&  )

delete

register_prefab()

void PrefabService::register_prefab	(	const std::string &	prefab_type_id,
		const PrefabFactory &	factory
	)

Register a prefab factory for a given type ID.

Parameters

prefab_type_id	Unique identifier for this prefab type
factory	Factory function that creates the GameObject with components

unregister_prefab()

void PrefabService::unregister_prefab

(

const std::string &

prefab_type_id

)

Unregister a previously registered prefab factory.

Parameters

prefab_type_id

Identifier of the prefab to unregister

---

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

• include/engine/public/prefab_service.h