Orpheu: GameRules Object

[Archive-Poster]

In half life based games, a portion of the game behaviour related to game rules and events is grouped in objects derived from an object named CGameRules. I've collected virtual functions of it (mod dependent and not) so you can use them out of the box after installing this pack.

A mandatory step of using those functions is retrieving the CGameRules derived object itself.

Code: Select all

#include <amxmodx>
#include <orpheu>
#include <orpheu_stocks>

new g_pGameRules

public plugin_precache()
{
    OrpheuRegisterHook(OrpheuGetFunction("InstallGameRules"),"OnInstallGameRules",OrpheuHookPost)
}
public OnInstallGameRules()
{
    g_pGameRules = OrpheuGetReturn() 
} 

This hooks the function InstallGameRules that exist on every mod and that creates the object we need. After this, our variable g_pGameRules will contain a reference to the object so we can after that hook and call functions of it. As a side note in TFC the function is a little bit different so I had to named it InstallGameRules_tfc. Take that into account if you are making a plugin that should work in TFC.

Now, hooking a function:
Example GetNextBestWeapon(CBasePlayer *, CBasePlayerItem *)

Code: Select all

public plugin_init()
{
/* GetNextBestWeapon is the name of the function. You can see the name of the function at configs\orpheu\virtualFunctions\CGameRules   
    CGameRules is the base object and is to be used in every function in the package
    OnGetNextBestWeapon is the name of our hook function
*/
  OrpheuRegisterHookFromObject(g_pGameRules,"GetNextBestWeapon","CGameRules","OnGetNextBestWeapon")
}

public OnGetNextBestWeapon(gameRules,playerID,weaponID)
{
    // Game rules object is always passed as the first argument but we don't need it since we already have it in g_pGameRules
} 

Now, to call a function:
Example: CanHaveAmmo(CBasePlayer *, char const *, int)

Code: Select all

new OrpheuFunction:CanHaveAmmo = OrpheuGetFunctionFromObject(g_pGameRules,"CanHaveAmmo","CGameRules")
    
// When you call any of those functions you have to pass g_pGameRules always as the first argument 
new result = OrpheuCall(CanHaveAmmo,g_pGameRules,id,"ammo_buckshot",30) 

If it sounds complicated or whatever, tell me.

After installing the package the functions will be at "configs\orpheu\virtualFunctions\CGameRul es". Check that folder and each file to know the arguments for each function and in which mod it works.

Supported mods:

Code: Select all

cstrike
czero
dod
tfc
ns
ts
SvenCoop
valve

Functions list:

Code: Select all

AddToTeamScores
AllowAutoTargetCrosshair
AmmoShouldRespawn
BloodSprite
BloodStream
bodyDamage
Bubbles
BubbleTrails
BuildableBuilt
BuildableKilled
BuildMiniMap
BulletTracers
Camera
CanEntityDoDamageTo
CanHaveAmmo
CanHaveItem
CanHavePlayerItem
ChangeLevel
ChangePlayerTeam
ChangePlayerTeam_dod
CheckMapConditions
CheckWinConditions
CleanUpMap
ClientCommand
ClientCommandDeadOrAlive
ClientCommand_dod
ClientConnected
ClientDisconnected
ClientUserInfoChanged
DeadPlayerAmmo
DeadPlayerWeapons
DeathNotice
DeathNotice_dod
EndMultiplayerGame
Explosion
FAllowFlashlight
FAllowMonsters
FlAmmoRespawnTime
FlHealthChargerRechargeTime
FlHEVChargerRechargeTime
FlItemRespawnTime
FlPlayerFallDamage
FlPlayerSpawnTime
FlWeaponRespawnTime
FlWeaponTryRespawn
FPlayerCanRespawn
FPlayerCanTakeDamage
FShouldSwitchWeapon
gerVoice
GetArePlayersAllowedToJoinImmediately
GetCombatAttackingTeamNumber
GetCountdownStarted
GetGameDescription
GetGameStarted
GetGameTime
GetIndexedTeamName
GetIsClientAuthorizedToPlay
GetIsCombatMode
GetIsHamboneMode
GetIsIronMan
GetIsNSMode
GetIsTournamentMode
GetIsTrainingMode
getMapTime
GetMaxWaveTime
GetNextBestWeapon
GetPlayerSpawnSpot
GetTeamID
GetTeamIndex
getWaveTime
GiveC4
GoToIntermission
Init
InitHUD
IPointsForKill
IsAllowedToSpawn
IsClanMatch
IsClanMatchActive
IsCoOp
IsDeathmatch
IsFreezePeriod
IsMultiplayer
IsRoundFrozen
IsTeamplay
IsValidTeam
ItemShouldRespawn
Pain
PerformHardAuthorization
PlayerGotAmmo
PlayerGotItem
PlayerGotWeapon
PlayerKilled
PlayerKilled_dod
PlayerRelationship
PlayerSpawn
PlayerThink
PlayFootstepSounds
PlayTextureSounds
PopHelmet
ProcessRespawnCostForPlayer
Prone
RecalculateHandicap
RecalculateMapMode
RefreshSkillData
RemoveGuns
RestartRound
ReturnGameRules
RewardPlayerForKill
RoundReset
roundRestartSound
RoundState
ScreenFades
SelectSpawnPoint
SendMOTDToClient
SendTeamScores
ServerDeactivate
SetBloodSprite
SetBloodStream
SetbodyDamage
SetBubbles
SetBubbleTrails
SetBulletTracers
SetCamera
SetClanMatch
SetDefaultPlayerTeam
SetExplosion
SetGameStarted
SetgerVoice
SetMapChangeFromTime
setMapTime
SetPain
SetPopHelmet
SetProne
SetRestartTime
SetRocketTrail
SetRoundReset
SetroundRestartSound
SetRoundState
SetScreenFades
SetShards
SetSmoke
SetSparkShower
SetTeamScores
SetusVoice
setWaveTime
Shards
ShouldAutoAim
Smoke
SparkShower
StartTrail
TeamScores
Think
UpdateGameMode
usVoice
VoteKick
WeaponShouldRespawn

Last note: this ended up extensive so I probably made more than one error. If a function doesn't work for you, tell me its name, the mod and the operative system. Bye.

[Archive-Poster]

Where can you find the source of these functions?

EDIT:

Nevermind.

multiplay_gamerules.cpp

[Archive-Poster]

It would be nice if someone could filter properly the functions available by game. Right now all is mixed and it's a pain to find something you can use.

There're 3 objects.

Code: Select all

CGameRules
CHalfLifeMultiplay
CHalfLifeRules

The last two inherites methods from CGameRules

Here's wha't I found in CS

Code: Select all

CGameRules::CanHaveAmmo(CBasePlayer *,char const *,int)
CGameRules::CanHavePlayerItem(CBasePlayer *,CBasePlayerItem *)
CGameRules::GetPlayerSpawnSpot(CBasePlayer *)
CGameRules::RefreshSkillData(void)
CHalfLifeMultiplay::AddToVIPQueue(CBasePlayer *)
CHalfLifeMultiplay::AllowAutoTargetCrosshair(void)
CHalfLifeMultiplay::AmmoShouldRespawn(CBasePlayerAmmo *)
CHalfLifeMultiplay::BalanceTeams(void)
CHalfLifeMultiplay::CHalfLifeMultiplay(void)
CHalfLifeMultiplay::CanHaveItem(CBasePlayer *,CItem *)
CHalfLifeMultiplay::CanHavePlayerItem(CBasePlayer *,CBasePlayerItem *)
CHalfLifeMultiplay::CareerRestart(void)
CHalfLifeMultiplay::ChangeLevel(void)
CHalfLifeMultiplay::CheckMapConditions(void)
CHalfLifeMultiplay::CheckWinConditions(void)
CHalfLifeMultiplay::CleanUpMap(void)
CHalfLifeMultiplay::ClientCommand(CBasePlayer *,char const *)
CHalfLifeMultiplay::ClientCommand_DeadOrAlive(CBasePlayer *,char const *)
CHalfLifeMultiplay::ClientConnected(edict_s *,char const *,char const *,char *)
CHalfLifeMultiplay::ClientDisconnected(edict_s *)
CHalfLifeMultiplay::ClientUserInfoChanged(CBasePlayer *,char *)
CHalfLifeMultiplay::DeadPlayerAmmo(CBasePlayer *)
CHalfLifeMultiplay::DeadPlayerWeapons(CBasePlayer *)
CHalfLifeMultiplay::DeathNotice(CBasePlayer *,entvars_s *,entvars_s *)
CHalfLifeMultiplay::DisplayMaps(CBasePlayer *,int)
CHalfLifeMultiplay::FAllowFlashlight(void)
CHalfLifeMultiplay::FAllowMonsters(void)
CHalfLifeMultiplay::FPlayerCanRespawn(CBasePlayer *)
CHalfLifeMultiplay::FPlayerCanTakeDamage(CBasePlayer *,CBaseEntity *)
CHalfLifeMultiplay::FShouldSwitchWeapon(CBasePlayer *,CBasePlayerItem *)
CHalfLifeMultiplay::FlAmmoRespawnTime(CBasePlayerAmmo *)
CHalfLifeMultiplay::FlHEVChargerRechargeTime(void)
CHalfLifeMultiplay::FlHealthChargerRechargeTime(void)
CHalfLifeMultiplay::FlItemRespawnTime(CItem *)
CHalfLifeMultiplay::FlPlayerFallDamage(CBasePlayer *)
CHalfLifeMultiplay::FlPlayerSpawnTime(CBasePlayer *)
CHalfLifeMultiplay::FlWeaponRespawnTime(CBasePlayerItem *)
CHalfLifeMultiplay::FlWeaponTryRespawn(CBasePlayerItem *)
CHalfLifeMultiplay::GetNextBestWeapon(CBasePlayer *,CBasePlayerItem *)
CHalfLifeMultiplay::GetPlayerSpawnSpot(CBasePlayer *)
CHalfLifeMultiplay::GiveC4(void)
CHalfLifeMultiplay::GoToIntermission(void)
CHalfLifeMultiplay::HasRoundTimeExpired(void)
CHalfLifeMultiplay::IPointsForKill(CBasePlayer *,CBasePlayer *)
CHalfLifeMultiplay::InitHUD(CBasePlayer *)
CHalfLifeMultiplay::IsAllowedToSpawn(CBaseEntity *)
CHalfLifeMultiplay::IsBombPlanted(void)
CHalfLifeMultiplay::IsCareer(void)
CHalfLifeMultiplay::IsCoOp(void)
CHalfLifeMultiplay::IsDeathmatch(void)
CHalfLifeMultiplay::IsInCareerRound(void)
CHalfLifeMultiplay::IsMultiplayer(void)
CHalfLifeMultiplay::IsThereABomb(void)
CHalfLifeMultiplay::IsThereABomber(void)
CHalfLifeMultiplay::IsVIPQueueEmpty(void)
CHalfLifeMultiplay::ItemShouldRespawn(CItem *)
CHalfLifeMultiplay::MarkLivingPlayersOnTeamAsNotReceivingMoneyNextRound(int)
CHalfLifeMultiplay::PickNextVIP(void)
CHalfLifeMultiplay::PlayerGotAmmo(CBasePlayer *,char *,int)
CHalfLifeMultiplay::PlayerGotItem(CBasePlayer *,CItem *)
CHalfLifeMultiplay::PlayerGotWeapon(CBasePlayer *,CBasePlayerItem *)
CHalfLifeMultiplay::PlayerKilled(CBasePlayer *,entvars_s *,entvars_s *)
CHalfLifeMultiplay::PlayerRelationship(CBasePlayer *,CBaseEntity *)
CHalfLifeMultiplay::PlayerSpawn(CBasePlayer *)
CHalfLifeMultiplay::PlayerThink(CBasePlayer *)
CHalfLifeMultiplay::ProcessMapVote(CBasePlayer *,int)
CHalfLifeMultiplay::QueueCareerRoundEndMenu(float,int)
CHalfLifeMultiplay::RefreshSkillData(void)
CHalfLifeMultiplay::RemoveGuns(void)
CHalfLifeMultiplay::ResetAllMapVotes(void)
CHalfLifeMultiplay::ResetCurrentVIP(void)
CHalfLifeMultiplay::RestartRound(void)
CHalfLifeMultiplay::SendMOTDToClient(edict_s *)
CHalfLifeMultiplay::ServerDeactivate(void)
CHalfLifeMultiplay::SetCareerMatchLimit(int,int)
CHalfLifeMultiplay::StackVIPQueue(void)
CHalfLifeMultiplay::SwapAllPlayers(void)
CHalfLifeMultiplay::TeamFull(int)
CHalfLifeMultiplay::TeamStacked(int,int)
CHalfLifeMultiplay::Think(void)
CHalfLifeMultiplay::UpdateGameMode(CBasePlayer *)
CHalfLifeMultiplay::UpdateTeamScores(void)
CHalfLifeMultiplay::VecAmmoRespawnSpot(CBasePlayerAmmo *)
CHalfLifeMultiplay::VecItemRespawnSpot(CItem *)
CHalfLifeMultiplay::VecWeaponRespawnSpot(CBasePlayerItem *)
CHalfLifeMultiplay::WeaponShouldRespawn(CBasePlayerItem *)
CHalfLifeRules::AllowAutoTargetCrosshair(void)
CHalfLifeRules::AmmoShouldRespawn(CBasePlayerAmmo *)
CHalfLifeRules::CHalfLifeRules(void)
CHalfLifeRules::CanHaveItem(CBasePlayer *,CItem *)
CHalfLifeRules::ClientConnected(edict_s *,char const *,char const *,char *)
CHalfLifeRules::ClientDisconnected(edict_s *)
CHalfLifeRules::DeadPlayerAmmo(CBasePlayer *)
CHalfLifeRules::DeadPlayerWeapons(CBasePlayer *)
CHalfLifeRules::DeathNotice(CBasePlayer *,entvars_s *,entvars_s *)
CHalfLifeRules::FAllowMonsters(void)
CHalfLifeRules::FPlayerCanRespawn(CBasePlayer *)
CHalfLifeRules::FShouldSwitchWeapon(CBasePlayer *,CBasePlayerItem *)
CHalfLifeRules::FlAmmoRespawnTime(CBasePlayerAmmo *)
CHalfLifeRules::FlHealthChargerRechargeTime(void)
CHalfLifeRules::FlItemRespawnTime(CItem *)
CHalfLifeRules::FlPlayerFallDamage(CBasePlayer *)
CHalfLifeRules::FlPlayerSpawnTime(CBasePlayer *)
CHalfLifeRules::FlWeaponRespawnTime(CBasePlayerItem *)
CHalfLifeRules::FlWeaponTryRespawn(CBasePlayerItem *)
CHalfLifeRules::GetNextBestWeapon(CBasePlayer *,CBasePlayerItem *)
CHalfLifeRules::GetPlayerSpawnSpot(CBasePlayer *)
CHalfLifeRules::IPointsForKill(CBasePlayer *,CBasePlayer *)
CHalfLifeRules::InitHUD(CBasePlayer *)
CHalfLifeRules::IsAllowedToSpawn(CBaseEntity *)
CHalfLifeRules::IsCoOp(void)
CHalfLifeRules::IsDeathmatch(void)
CHalfLifeRules::IsMultiplayer(void)
CHalfLifeRules::ItemShouldRespawn(CItem *)
CHalfLifeRules::PlayerGotAmmo(CBasePlayer *,char *,int)
CHalfLifeRules::PlayerGotItem(CBasePlayer *,CItem *)
CHalfLifeRules::PlayerGotWeapon(CBasePlayer *,CBasePlayerItem *)
CHalfLifeRules::PlayerKilled(CBasePlayer *,entvars_s *,entvars_s *)
CHalfLifeRules::PlayerRelationship(CBasePlayer *,CBaseEntity *)
CHalfLifeRules::PlayerSpawn(CBasePlayer *)
CHalfLifeRules::PlayerThink(CBasePlayer *)
CHalfLifeRules::Think(void)
CHalfLifeRules::VecAmmoRespawnSpot(CBasePlayerAmmo *)
CHalfLifeRules::VecItemRespawnSpot(CItem *)
CHalfLifeRules::VecWeaponRespawnSpot(CBasePlayerItem *)
CHalfLifeRules::WeaponShouldRespawn(CBasePlayerItem *) 

Don't know if CHalfLifeMultiplay and CHalfLifeRules can be referenced from CGameRules. I guess not.

[Archive-Poster]

CGameRules is the parent base class that CHalfLifeRules and CHalfLifeGamePlay derive from. In a single player game you have a CHalfLifeRules object, in a multiplayer you have a CHalfLifeMultiplay (Arkshine correct me if I'm wrong ).

This thread is about virtual functions of CGameRules

Anyway, you can use any of those functions with signatures but, this is for virtual functions to make it easy to address them (by providing only an offset)

[Archive-Poster]

for someone to find available functions in each mod.

So in CS theres only 4 used?

Code: Select all

CGameRules::CanHaveAmmo(CBasePlayer *,char const *,int)
CGameRules::CanHavePlayerItem(CBasePlayer *,CBasePlayerItem *)
CGameRules::GetPlayerSpawnSpot(CBasePlayer *)
CGameRules::RefreshSkillData(void)

Code: Select all

[0][RefreshSkillData]
[1][Think]
[2][IsAllowedToSpawn]
[3][FAllowFlashlight]
[4][FShouldSwitchWeapon]
[5][GetNextBestWeapon]
[6][IsMultiplayer]
[7][IsDeathmatch]
[8][IsTeamplay]
[9][IsCoOp]
[10][GetGameDescription]
[11][ClientConnected]
[12][InitHUD]
[13][ClientDisconnected]
[14][UpdateGameMode]
[15][FlPlayerFallDamage]
[16][FPlayerCanTakeDamage]
[17][ShouldAutoAim]
[18][PlayerSpawn]
[19][PlayerThink]
[20][FPlayerCanRespawn]
[21][FlPlayerSpawnTime]
[22][GetPlayerSpawnSpot]
[23][AllowAutoTargetCrosshair]
[24][ClientCommandDeadOrAlive]
[25][ClientCommand]
[26][ClientUserInfoChanged]
[27][IPointsForKill]
[28][PlayerKilled]
[29][DeathNotice]
[30][CanHavePlayerItem]
[31][PlayerGotWeapon]
[32][WeaponShouldRespawn]
[33][FlWeaponRespawnTime]
[34][FlWeaponTryRespawn]
[35][VecWeaponRespawnSpot]
[36][CanHaveItem]
[37][PlayerGotItem]
[38][ItemShouldRespawn]
[39][FlItemRespawnTime]
[40][VecItemRespawnSpot]
[41][CanHaveAmmo]
[42][PlayerGotAmmo]
[43][AmmoShouldRespawn]
[44][FlAmmoRespawnTime]
[45][VecAmmoRespawnSpot]
[46][FlHealthChargerRechargeTime]
[47][FlHEVChargerRechargeTime]
[48][DeadPlayerWeapons]
[49][DeadPlayerAmmo]
[50][GetTeamID]
[51][PlayerRelationship]
[52][GetTeamIndex]
[53][GetIndexedTeamName]
[54][IsValidTeam]
[55][ChangePlayerTeam]
[56][SetDefaultPlayerTeam]
[57][PlayTextureSounds]
[58][FAllowMonsters]
[59][EndMultiplayerGame]
[60][IsFreezePeriod]
[61][ServerDeactivate]
[62][CheckMapConditions]
[63][CleanUpMap]
[64][RestartRound]
[65][CheckWinConditions]
[66][RemoveGuns]
[67][GiveC4]
[68][ChangeLevel]
[69][GoToIntermission]

[Archive-Poster]

Right, I understand now (I think).

For example, GiveC4 it's a virtual function of gamerules and, in case of HalfLifeMultiPlay, it's handled there.

That's why I can't see inside cs_i386.so any CGameRules::GiveC4.

I'm correct?

A virtual function is a function that can be overrided by another in a derived class. In this case GiveC4 seems to be a virtual function belonging to CHalfLifeMultiplay and not from CGameRules. So, the files aren't quite correct.