CGame - Revision history

Outerbeast at 19:55, 13 March 2025

2025-03-13T19:55:57Z

← Older revision		Revision as of 21:55, 13 March 2025
Line 4:		Line 4:

	A single global instance exists:<code>CGame g_Game;</code>		A single global instance exists:<code>CGame g_Game;</code>
	~~===~~== Methods ~~===~~==		== Methods ==

	Precache methods		=== Precache methods ===

	{\| class="wikitable"		{\| class="wikitable"
Line 35:		Line 35:
	\|}		\|}

	AlertMessage		=== AlertMessage ===
	<nowiki>bool AlertMessage(ALERT_TYPE aType, const string& in szFormat, ...)</nowiki>		<nowiki>bool AlertMessage(ALERT_TYPE aType, const string& in szFormat, ...)</nowiki>
	Outputs a message to the console. Uses SC printf formatting style. Supports a variable number of arguments.		Outputs a message to the console. Uses SC printf formatting style. Supports a variable number of arguments.
Line 41:		Line 41:
	See the ALERT_TYPE enum.		See the ALERT_TYPE enum.

			=== GetGameName ===
	GetGameName
	<nowiki>string GetGameName() const</nowiki>		<nowiki>string GetGameName() const</nowiki>
	Returns the game name.		Returns the game name.

	GetGameVersionString		=== GetGameVersionString ===
	<nowiki>string GetGameVersionString() const</nowiki>		<nowiki>string GetGameVersionString() const</nowiki>
	Returns the game version as a string, e.g. "5.0".		Returns the game version as a string, e.g. "5.0".

	GetGameVersion		=== GetGameVersion ===
	<nowiki>uint32 GetGameVersion() const</nowiki>		<nowiki>uint32 GetGameVersion() const</nowiki>
	Returns the game version as a number, e.g. 500: major version, minor version (3.0 becomes 300, 4.0b1 becomes 401, 4.06 becomes 406, 4.5 becomes 450, etc...)		Returns the game version as a number, e.g. 500: major version, minor version (3.0 becomes 300, 4.0b1 becomes 401, 4.06 becomes 406, 4.5 becomes 450, etc...)

	[[Category:Scripting]]		[[Category:Scripting]]

Outerbeast at 21:57, 14 February 2025

2025-02-14T21:57:04Z

← Older revision		Revision as of 23:57, 14 February 2025
Line 3:		Line 3:
	The HTML documentation can be found here.		The HTML documentation can be found here.

	A single global instance exists:		A single global instance exists:<code>CGame g_Game;</code>
	<~~nowiki~~>
	CGame g_Game;
	</~~nowiki~~>
	===== Methods =====		===== Methods =====

Line 18:		Line 15:
	\|-		\|-
	\| PrecacheModel		\| PrecacheModel
	\| int PrecacheModel(const string& in szFileName)		\|<code>int PrecacheModel(const string& in szFileName)
	\| Precaches a model. Shuts down the game if not found. Can only be called from MapInit. Returns the model's index.		\| Precaches a model. Shuts down the game if not found. Can only be called from MapInit. Returns the model's index.
	\|-		\|-
	\| PrecacheModel		\| PrecacheModel
	\| int PrecacheModel(CBaseEntity@ pEntity, const string& in szFileName)		\|<code>int PrecacheModel(CBaseEntity@ pEntity, const string& in szFileName)
	\| Precaches a model. Shuts down the game if not found. Can only be called from MapInit. Returns the model's index.		\| Precaches a model. Shuts down the game if not found. Can only be called from MapInit. Returns the model's index.
	\|-		\|-
	\| PrecacheOther		\| PrecacheOther
	\| void PrecacheOther(const string& in szClassName)		\|<code>void PrecacheOther(const string& in szClassName)
	\| This effectively instances an entity with the given class name, calls precache on it, and removes the entity.		\| This effectively instances an entity with the given class name, calls precache on it, and removes the entity.
	\|-		\|-
	\| PrecacheMonster		\| PrecacheMonster
	\| void PrecacheMonster(const string& in szClassName, bool fAlly)		\|<code>void PrecacheMonster(const string& in szClassName, bool fAlly)
	\| This effectively instances a monster entity with the given class name, calls precache on it, and removes the entity. szClassName is the given entity's classname, fAlly is whether this is an ally or enemy monster.		\| This effectively instances a monster entity with the given class name, calls precache on it, and removes the entity. szClassName is the given entity's classname, fAlly is whether this is an ally or enemy monster.
	\|-		\|-
	\| PrecacheGeneric		\| PrecacheGeneric
	\| void PrecacheGeneric(const string& in szFileName)		\|<code>void PrecacheGeneric(const string& in szFileName)
	\| Precaches a file for download to clients.		\| Precaches a file for download to clients.
	\|}		\|}

	AlertMessage		AlertMessage
	<nowiki>		<nowiki>bool AlertMessage(ALERT_TYPE aType, const string& in szFormat, ...)</nowiki>
	bool AlertMessage(ALERT_TYPE aType, const string& in szFormat, ...)
	</nowiki>
	Outputs a message to the console. Uses SC printf formatting style. Supports a variable number of arguments.		Outputs a message to the console. Uses SC printf formatting style. Supports a variable number of arguments.

Line 48:		Line 43:

	GetGameName		GetGameName
	<nowiki>		<nowiki>string GetGameName() const</nowiki>
	string GetGameName() const
	Returns the game name.		Returns the game name.

	GetGameVersionString		GetGameVersionString
	<nowiki>		<nowiki>string GetGameVersionString() const</nowiki>
	string GetGameVersionString() const
	</nowiki>
	Returns the game version as a string, e.g. "5.0".		Returns the game version as a string, e.g. "5.0".

	GetGameVersion		GetGameVersion
	<nowiki>		<nowiki>uint32 GetGameVersion() const</nowiki>
	uint32 GetGameVersion() const
	</nowiki>
	Returns the game version as a number, e.g. 500: major version, minor version (3.0 becomes 300, 4.0b1 becomes 401, 4.06 becomes 406, 4.5 becomes 450, etc...)		Returns the game version as a number, e.g. 500: major version, minor version (3.0 becomes 300, 4.0b1 becomes 401, 4.06 becomes 406, 4.5 becomes 450, etc...)

	[[Category:Scripting]]		[[Category:Scripting]]

Outerbeast at 19:02, 13 February 2025

2025-02-13T19:02:03Z

← Older revision		Revision as of 21:02, 13 February 2025
Line 63:		Line 63:
	</nowiki>		</nowiki>
	Returns the game version as a number, e.g. 500: major version, minor version (3.0 becomes 300, 4.0b1 becomes 401, 4.06 becomes 406, 4.5 becomes 450, etc...)		Returns the game version as a number, e.g. 500: major version, minor version (3.0 becomes 300, 4.0b1 becomes 401, 4.06 becomes 406, 4.5 becomes 450, etc...)

			[[Category:Scripting]]

Outerbeast at 19:01, 13 February 2025

2025-02-13T19:01:35Z

@@ Line 8: / Line 8: @@
 </nowiki>
 ===== Methods =====
 AlertMessage
   <nowiki>
@@ Line 16: / Line 46: @@
 See the ALERT_TYPE enum.
 GetGameName

Outerbeast: Created page with "This class contains methods integral to the operation of the game. You will often use these. The HTML documentation can be found here. A single global instance exists:
2025-02-13T18:51:42Z

Created page with "This class contains methods integral to the operation of the game. You will often use these. The HTML documentation can be found here. A single global instance exists: <now..."

New page
This class contains methods integral to the operation of the game. You will often use these.

The HTML documentation can be found here.

A single global instance exists:
<nowiki>
CGame g_Game;
</nowiki>
===== Methods =====
AlertMessage
<nowiki>
bool AlertMessage(ALERT_TYPE aType, const string& in szFormat, ...)
</nowiki>
Outputs a message to the console. Uses SC printf formatting style. Supports a variable number of arguments.

See the ALERT_TYPE enum.

PrecacheModel
<nowiki>
int PrecacheModel(const string& in szFileName)
</nowiki>
Precaches a model.

Shuts down the game if not found. Can only be called from MapInit.

Returns the model's index.

PrecacheModel
<nowiki>
int PrecacheModel(CBaseEntity@ pEntity, const string& in szFileName)
</nowiki>
Precaches a model.

Shuts down the game if not found. Can only be called from entity Precache methods.

Returns the model's index.

PrecacheOther
<nowiki>
void PrecacheOther(const string& in szClassName)
</nowiki>
Precaches an entity.

This effectively instances an entity with the given class name, calls precache on it, and removes the entity.

PrecacheMonster
<nowiki>
void PrecacheMonster(const string& in szClassName, bool fAlly)
</nowiki>
Precaches a monster entity.

This effectively instances a monster entity with the given class name, calls precache on it, and removes the entity.
<nowiki>
Argument Description
szClassName Entity class name.
fAlly Whether this is an ally or enemy monster.
PrecacheGeneric
void PrecacheGeneric(const string& in szFileName)
Precaches a file for download to clients.
</nowiki>

GetGameName
<nowiki>
string GetGameName() const
Returns the game name.

GetGameVersionString
<nowiki>
string GetGameVersionString() const
</nowiki>
Returns the game version as a string, e.g. "5.0".

GetGameVersion
<nowiki>
uint32 GetGameVersion() const
</nowiki>
Returns the game version as a number, e.g. 500: major version, minor version (3.0 becomes 300, 4.0b1 becomes 401, 4.06 becomes 406, 4.5 becomes 450, etc...)