BlamWorldState Class Reference

Class representing a world state. More...

#include <world_objects.h>

Inheritance diagram for BlamWorldState:

Collaboration diagram for BlamWorldState:

Public Member Functions
	BlamWorldState ()
	Initializes a new world state. More...
	~BlamWorldState ()
	Destroys the world state. More...
void	AddObject (BlamWorldObject *object)
bool	RemoveObject (uint64_t object_id, bool delete_data=true)
int	GetObjectCount ()
bool	HasObject (uint64_t object_id)
BlamWorldObject *	GetObjectAtIndex (int index)
BlamWorldObject *	GetObjectById (uint64_t object_id)
BlamWorldObject *	GetObjectByName (std::string name, bool recursive_search=false)
bool	Drop (BlamTagData *tag_data, BlamVector3 position)
	Drops a tag into the world at the specified coordinates. More...
void	OnTickEvent (TickEvent *event)
void	RenderObjects (float delta)
void	SetActiveCamera (BlamWorldObject_Tag *camera)
BlamWorldObject_Tag *	GetActiveCamera ()
BlamWorldObject_Tag *	CreateTagObject (BlamTagData *tag_data, bool add_to_world=true)

Public Attributes
Ogre::SceneNode *	root_node = nullptr

Detailed Description

Class representing a world state.

The world state stores all data related to the current state of the world in-engine. Primarily, this will include a list of all world objects currently placed down.

Constructor & Destructor Documentation

BlamWorldState()

BlamWorldState::BlamWorldState

(

)

Initializes a new world state.

Here is the call graph for this function:

~BlamWorldState()

BlamWorldState::~BlamWorldState

(

)

Destroys the world state.

Here is the call graph for this function:

Member Function Documentation

AddObject()

void BlamWorldState::AddObject

(

BlamWorldObject *

object

)

Here is the call graph for this function:

Here is the caller graph for this function:

CreateTagObject()

BlamWorldObject_Tag * BlamWorldState::CreateTagObject	(	BlamTagData *	tag_data,
		bool	add_to_world = true
	)

Here is the call graph for this function:

Here is the caller graph for this function:

Drop()

bool BlamWorldState::Drop	(	BlamTagData *	tag_data,
		BlamVector3	position
	)

Drops a tag into the world at the specified coordinates.

This method will create a new world object from the specified tag.

Parameters

tag_data	- The tag data to use to create the new world object.
position	- The position to place the new object at.

Returns

true if the tag was successfully dropped into the world, otherwise returns false.

Here is the call graph for this function:

GetActiveCamera()

BlamWorldObject_Tag * BlamWorldState::GetActiveCamera

(

)

Here is the caller graph for this function:

GetObjectAtIndex()

BlamWorldObject * BlamWorldState::GetObjectAtIndex

(

int

index

)

Here is the caller graph for this function:

GetObjectById()

BlamWorldObject * BlamWorldState::GetObjectById

(

uint64_t

object_id

)

GetObjectByName()

BlamWorldObject * BlamWorldState::GetObjectByName	(	std::string	name,
		bool	recursive_search = false
	)

Here is the call graph for this function:

Here is the caller graph for this function:

GetObjectCount()

int BlamWorldState::GetObjectCount

(

)

Here is the caller graph for this function:

HasObject()

bool BlamWorldState::HasObject

(

uint64_t

object_id

)

Here is the caller graph for this function:

OnTickEvent()

void BlamWorldState::OnTickEvent

(

TickEvent *

event

)

RemoveObject()

bool BlamWorldState::RemoveObject	(	uint64_t	object_id,
		bool	delete_data = true
	)

Here is the call graph for this function:

Here is the caller graph for this function:

RenderObjects()

void BlamWorldState::RenderObjects

(

float

delta

)

Here is the caller graph for this function:

SetActiveCamera()

void BlamWorldState::SetActiveCamera

(

BlamWorldObject_Tag *

camera

)

Here is the caller graph for this function:

Member Data Documentation

root_node

Ogre::SceneNode* BlamWorldState::root_node = nullptr

---

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

• blam/api/v1/types/world_objects.h
• blam/api/v1/types/world/BlamWorldState.cpp