Class representing a world object. More...

#include <world_objects.h>

Inheritance diagram for BlamWorldObject:

Collaboration diagram for BlamWorldObject:

Public Member Functions
	BlamWorldObject (BlamWorldState *_world, BlamWorldObjectType _type)
	Creates a new world object. More...

virtual	~BlamWorldObject ()

virtual void	Render ()
	Renders the object to the screen. More...

Public Attributes
std::string	name = "unnamed"
	The unique name of this object. More...

std::string	description = ""
	An optional description of this object. More...

int	editor_folder_id = 0
	The editor folder that this object exists within. Only used within the editing kit. More...

uint64_t	id = 0
	A unique identifier for this object. Used to identify objects during runtime. More...

BlamWorldState *	world = nullptr
	The world state this object belongs to. More...

BlamVector3	position = { 0, 0, 0 }
	The position of this object in world space. More...

BlamVector3	rotation = { 0, 0, 0 }
	The rotation of this object in world space. More...

BlamVector3	scale = { 1, 1, 1 }
	The scale/size of the object. More...

BlamWorldObjectType	type = BlamWorldObjectType::Unspecified
	The type of this world object. More...

Detailed Description

Class representing a world object.

The world object will have several properties that can be modified on a per-object basis, such as a custom name, position, and rotation.

Constructor & Destructor Documentation

◆ BlamWorldObject()

BlamWorldObject::BlamWorldObject	(	BlamWorldState *	_world,
		BlamWorldObjectType	_type
	)

Creates a new world object.

Parameters

_world	- The world state this object should belong to.
_type	- The type of world object being created.

◆ ~BlamWorldObject()

virtual BlamWorldObject::~BlamWorldObject ( )

inlinevirtual

Member Function Documentation

◆ Render()

void BlamWorldObject::Render ( )

virtual

Renders the object to the screen.

Reimplemented in BlamWorldObject_Primitive, and BlamWorldObject_Tag.

Here is the caller graph for this function:

Member Data Documentation

◆ description

std::string BlamWorldObject::description = ""

An optional description of this object.

◆ editor_folder_id

int BlamWorldObject::editor_folder_id = 0

The editor folder that this object exists within. Only used within the editing kit.

◆ id

uint64_t BlamWorldObject::id = 0

A unique identifier for this object. Used to identify objects during runtime.

◆ name

std::string BlamWorldObject::name = "unnamed"

The unique name of this object.

◆ position

BlamVector3 BlamWorldObject::position = { 0, 0, 0 }

The position of this object in world space.

◆ rotation

BlamVector3 BlamWorldObject::rotation = { 0, 0, 0 }

The rotation of this object in world space.

◆ scale

BlamVector3 BlamWorldObject::scale = { 1, 1, 1 }

The scale/size of the object.

◆ type

BlamWorldObjectType BlamWorldObject::type = BlamWorldObjectType::Unspecified

The type of this world object.

◆ world

BlamWorldState* BlamWorldObject::world = nullptr

The world state this object belongs to.

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

blam/api/v1/types/world_objects.h
blam/api/v1/types/world/BlamWorldObject.cpp

Public Member Functions

Public Attributes