ime::ExcludeList Class Reference

A GameObject collision exclusion list. More...

#include <ExcludeList.h>

Public Member Functions
void	add (const std::string &group)
	Add a group to the list. More...
bool	remove (const std::string &group)
	Remove a group from the list. More...
bool	contains (const std::string &group)
	Check if the list has a group or not. More...
std::size_t	getCount () const
	Get the number of groups in the list. More...
void	clear ()
	Remove all groups from the list. More...

Detailed Description

A GameObject collision exclusion list.

This class allows a GameObject to select which other game objects it should not collide with

Definition at line 39 of file ExcludeList.h.

Member Function Documentation

add()

void ime::ExcludeList::add

(

const std::string &

group

)

Add a group to the list.

Parameters

group

The name of the group to be added

clear()

void ime::ExcludeList::clear

(

)

Remove all groups from the list.

contains()

bool ime::ExcludeList::contains

(

const std::string &

group

)

Check if the list has a group or not.

Parameters

group

The name of the group to be checked

Returns

True if the group exits in the list, otherwise false

getCount()

std::size_t ime::ExcludeList::getCount

(

)

const

Get the number of groups in the list.

Returns

The number of groups in the list

remove()

bool ime::ExcludeList::remove

(

const std::string &

group

)

Remove a group from the list.

Parameters

group

The name of the group to be removed

Returns

True if the group was removed from the list or false if it does not exist

---

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

• ExcludeList.h