OpenXcom::SoldierNamePool Class Reference

Pool of soldier names to generate random names. More...

#include <SoldierNamePool.h>

Public Member Functions
	SoldierNamePool ()
	Creates a blank pool. More...
	~SoldierNamePool ()
	Cleans up the pool.
void	load (const std::string &filename)
	Loads the pool from YAML. More...
std::string	genName (SoldierGender *gender, int femaleFrequency) const
	Generates a new name from the pool. More...
size_t	genLook (size_t numLooks)
	Generates an int representing the index of the soldier's look, when passed the maximum index value. More...

Detailed Description

Pool of soldier names to generate random names.

Each pool contains a set of first names (male or female) and last names. The first names define the soldier's gender, and are randomly associated with a last name.

Constructor & Destructor Documentation

SoldierNamePool()

OpenXcom::SoldierNamePool::SoldierNamePool

(

)

Creates a blank pool.

Initializes a new pool with blank lists of names.

Member Function Documentation

genLook()

size_t OpenXcom::SoldierNamePool::genLook

(

size_t

numLooks

)

Generates an int representing the index of the soldier's look, when passed the maximum index value.

Parameters

numLooks

The maximum index.

Returns

The index of the soldier's look.

genName()

std::string OpenXcom::SoldierNamePool::genName	(	SoldierGender *	gender,
		int	femaleFrequency
	)		const

Generates a new name from the pool.

Returns a new random name (first + last) from the lists of names contained within.

Parameters

gender

Returned gender of the name.

Returns

The soldier's name.

load()

void OpenXcom::SoldierNamePool::load

(

const std::string &

filename

)

Loads the pool from YAML.

Loads the pool from a YAML file.

Parameters

filename

YAML file.

---

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

• SoldierNamePool.h
• SoldierNamePool.cpp