src/ai/api/ai_settings.hpp
author truebrain
Mon, 31 Mar 2008 08:45:05 +0000
branchnoai
changeset 9839 ea94d60d13e7
parent 9829 80fbe02a4184
permissions -rw-r--r--
(svn r12505) [NoAI] -Documentation: still forgot some files ;) (minor stuff, capitals mostly)
/* $Id$ */

/** @file ai_settings.hpp Everything to change AI settings. */

#ifndef AI_SETTINGS_HPP
#define AI_SETTINGS_HPP

#include "ai_object.hpp"

/**
 * Class that handles all AI settings related functions.
 */
class AISettings : public AIObject {
public:
	static const char *GetClassName() { return "AISettings"; }

	/**
	 * Change the minimum amount of time the AI should be put in suspend mode
	 *   when you execute a command. Normally in SP this is 1, and in MP it is
	 *   what ever delay the server has been programmed to delay commands
	 *   (normally between 1 and 5). To give a more 'real' effect to your AI,
	 *   you can control that number here.
	 * @param ticks The minimum amount of ticks to wait.
	 * @pre Ticks should be positive. Too big values will influence performance of the AI.
	 * @note If the number is lower then the MP setting, the MP setting wins.
	 */
	static void SetCommandDelay(uint ticks);
};

#endif /* AI_SETTINGS_HPP */