AlliedModders - get_user_msgid() fails to work on server startup?

AlliedModders (https://forums.alliedmods.net/index.php)

- General (https://forums.alliedmods.net/forumdisplay.php?f=7)

- - get_user_msgid() fails to work on server startup? (https://forums.alliedmods.net/showthread.php?t=308592)

get_user_msgid() fails to work on server startup?

I just noticed something weird. I made a simple code to demonstrate.

PHP Code:


		
			
#include <amxmodx>

public plugin_precache()
    log_amx("%i %i %i", get_user_msgid("TeamInfo"), get_user_msgid("Damage"), get_user_msgid("ScreenFade"))

The output of this code is "0 0 0" on server start.
After I restart the server with the "restart" command or change the map, the output is "86 71 98" as it should be.

I tested both on 1.8.3 latest dev build and 1.8.2. The results are the same. It happens with any message.
However, if I change the event to plugin_init() instead of plugin_precache(), it works normally.

Am I missing something or is this a bug?

Re: get_user_msgid() fails to work on server startup?

Most likely get_user_msgid is assigned it's values after plugin_precache is triggered, that's why you're getting null values.

Re: get_user_msgid() fails to work on server startup?

Quote:

Originally Posted by edon1337 (Post 2599414)

Most likely get_user_msgid is assigned it's values after plugin_precache is triggered, that's why you're getting null values.

It is during plugin_precache, but you can't get it at plugin_precache.
Also it only return msgId, and do not have an valid reason to work with this on plugin_precache

Re: get_user_msgid() fails to work on server startup?

plugin_precache is useful for hooking WeaponList via register_message which requires get_user_msgid call.

Re: get_user_msgid() fails to work on server startup?

Quote:

Originally Posted by PRoSToTeM@ (Post 2607105)

plugin_precache is useful for hooking WeaponList via register_message which requires get_user_msgid call.

Nope:

PHP Code:


		
			
#include <amxmodx>

public plugin_precache()
{
    log_amx("%i", register_message(get_user_msgid("WeaponList"), "TestFunc"))
}

public TestFunc()
{
    static i; i++
    log_amx("test success %i", i)
}

Prints 0 on server start.
Prints 1 and "test success" 29 times after server restart or mapchange.

I already submitted a pull request to add a warning for this function in the documentation - https://github.com/alliedmodders/amxmodx/pull/506
Correct me if there's indeed a bug that needs to be fixed.

Re: get_user_msgid() fails to work on server startup?

Quote:

Originally Posted by OciXCrom (Post 2607107)

Nope:

Yeah, I know, I only want to say that there is an application for that, but it doesn't work as expected.

Quote:

Originally Posted by OciXCrom (Post 2607107)

I already submitted a pull request to add a warning for this function in the documentation - https://github.com/alliedmodders/amxmodx/pull/506

That's why I'm here.

Quote:

Originally Posted by OciXCrom (Post 2607107)

Correct me if there's indeed a bug that needs to be fixed.

If register_message will work on startup (with substituted WeaponList msgid constant), then get_user_msgid is bugged. If not, then register_message & get_user_msgid are both bugged.

UPD: register_message works, so only get_user_msgid is bugged.

Re: get_user_msgid() fails to work on server startup?

Not really a bug I believe. It's just that the game registers such messages in pfnServerActivate.

plugin_precache() is called before, at the first word pfnSpawn. So you can't use get_user_msgid() at this point at the first server start because not cached yet.
plugin_init() is called after in pfnServerActivate as post. It's too late to hook for WeaponList.

One possible solution is to hook FM_RegUserMsg, and hooking WeaponList once the message is registered (In CS, the WeaponList messages are fired right after the message is registered).

Probably not fixable unless we implement a dedicated forward which would be fired once all the messages are registered.

Re: get_user_msgid() fails to work on server startup?

Ye, plugin_precache is called from first spawn (from SV_LoadEntities). And usermsg registering is called from SV_ActivateServer (pfnServerActivate callback). SV_ActivateServer is called after SV_LoadEntities. As @Arkshine said the only and best way is to hook FM_RegUserMsg.

Possibly we can add register_message_lazy which would get usermsg name instead of id and retrieve msgid when the first message is sent.

Re: get_user_msgid() fails to work on server startup?

This didn't work for me

PHP Code:


		
			
public plugin_init( )
{
    register_forward( FM_RegUserMsg, "@RegUserMsg" );
}

@RegUserMsg( szMsg[ ], iSize )
{
    register_message( get_user_msgid( "WeaponList" ), "OnMessageWeaponList" );
}

public OnMessageWeaponList( )
{
    new iAmmoIndex = get_msg_arg_int( 2 );
    new iAmmoCount = get_msg_arg_int( 3 );
    new iWeaponID = get_msg_arg_int( 8 );
    
    g_eAmmoIndex[ iWeaponID ][ AmmoIndex ] = iAmmoIndex;
    g_eAmmoIndex[ iWeaponID ][ AmmoCount ] = iAmmoCount;
    
    log_to_file( "Weaponlist.txt", "%d %d %d", iAmmoIndex, iAmmoCount, iWeaponID );
}

EDIT:
I forgot I had to hook FM_RegUserMsg in plugin_precache, works now.

Re: get_user_msgid() fails to work on server startup?

You have to check when WeaponList is being registered, then getting the return value.
RegUserMsg is going to be called for all the messages at once.

The game does that essentially:

Spoiler

Code:

void LinkUserMessages()

{

        if (gmsgCurWeapon)

                return;



        gmsgCurWeapon     = REG_USER_MSG("CurWeapon", 3);

        gmsgGeigerRange   = REG_USER_MSG("Geiger", 1);

        gmsgFlashlight    = REG_USER_MSG("Flashlight", 2);

        gmsgFlashBattery  = REG_USER_MSG("FlashBat", 1);

        gmsgHealth        = REG_USER_MSG("Health", 1);

        gmsgDamage        = REG_USER_MSG("Damage", 12);

        gmsgBattery       = REG_USER_MSG("Battery", 2);

        gmsgTrain         = REG_USER_MSG("Train", 1);

        gmsgHudTextPro    = REG_USER_MSG("HudTextPro", -1);

        gmsgHudText       = REG_USER_MSG("HudText", -1);

        gmsgSayText       = REG_USER_MSG("SayText", -1);

        gmsgTextMsg       = REG_USER_MSG("TextMsg", -1);

        gmsgWeaponList    = REG_USER_MSG("WeaponList", -1);

        gmsgResetHUD      = REG_USER_MSG("ResetHUD", 0);

        gmsgInitHUD       = REG_USER_MSG("InitHUD", 0);

        gmsgViewMode      = REG_USER_MSG("ViewMode", 0);

        gmsgShowGameTitle = REG_USER_MSG("GameTitle", 1);

        gmsgDeathMsg      = REG_USER_MSG("DeathMsg", -1);

        gmsgScoreAttrib   = REG_USER_MSG("ScoreAttrib", 2);

        gmsgScoreInfo     = REG_USER_MSG("ScoreInfo", 9);

        gmsgTeamInfo      = REG_USER_MSG("TeamInfo", -1);

        gmsgTeamScore     = REG_USER_MSG("TeamScore", -1);

        gmsgGameMode      = REG_USER_MSG("GameMode", 1);

        gmsgMOTD          = REG_USER_MSG("MOTD", -1);

        gmsgServerName    = REG_USER_MSG("ServerName", -1);

        gmsgAmmoPickup    = REG_USER_MSG("AmmoPickup", 2);

        gmsgWeapPickup    = REG_USER_MSG("WeapPickup", 1);

        gmsgItemPickup    = REG_USER_MSG("ItemPickup", -1);

        gmsgHideWeapon    = REG_USER_MSG("HideWeapon", 1);

        gmsgSetFOV        = REG_USER_MSG("SetFOV", 1);

        gmsgShowMenu      = REG_USER_MSG("ShowMenu", -1);

        gmsgShake         = REG_USER_MSG("ScreenShake", 6);

        gmsgFade          = REG_USER_MSG("ScreenFade", 10);

        gmsgAmmoX         = REG_USER_MSG("AmmoX", 2);

        gmsgSendAudio     = REG_USER_MSG("SendAudio", -1);

        gmsgRoundTime     = REG_USER_MSG("RoundTime", 2);

        gmsgMoney         = REG_USER_MSG("Money", 5);

        gmsgArmorType     = REG_USER_MSG("ArmorType", 1);

        gmsgBlinkAcct     = REG_USER_MSG("BlinkAcct", 1);

        gmsgStatusValue   = REG_USER_MSG("StatusValue", -1);

        gmsgStatusText    = REG_USER_MSG("StatusText", -1);

        gmsgStatusIcon    = REG_USER_MSG("StatusIcon", -1);

        gmsgBarTime       = REG_USER_MSG("BarTime", 2);

        gmsgReloadSound   = REG_USER_MSG("ReloadSound", 2);

        gmsgCrosshair     = REG_USER_MSG("Crosshair", 1);

        gmsgNVGToggle     = REG_USER_MSG("NVGToggle", 1);

        gmsgRadar         = REG_USER_MSG("Radar", 7);

        gmsgSpectator     = REG_USER_MSG("Spectator", 2);

        gmsgVGUIMenu      = REG_USER_MSG("VGUIMenu", -1);

        gmsgTutorText     = REG_USER_MSG("TutorText", -1);

        gmsgTutorLine     = REG_USER_MSG("TutorLine", -1);

        gmsgTutorState    = REG_USER_MSG("TutorState", -1);

        gmsgTutorClose    = REG_USER_MSG("TutorClose", -1);

        gmsgAllowSpec     = REG_USER_MSG("AllowSpec", 1);

        gmsgBombDrop      = REG_USER_MSG("BombDrop", 7);

        gmsgBombPickup    = REG_USER_MSG("BombPickup", 0);

        gmsgSendCorpse    = REG_USER_MSG("ClCorpse", -1);

        gmsgHostagePos    = REG_USER_MSG("HostagePos", 8);

        gmsgHostageK      = REG_USER_MSG("HostageK", 1);

        gmsgHLTV          = REG_USER_MSG("HLTV", 2);

        gmsgSpecHealth    = REG_USER_MSG("SpecHealth", 1);

        gmsgForceCam      = REG_USER_MSG("ForceCam", 3);

        gmsgADStop        = REG_USER_MSG("ADStop", 0);

        gmsgReceiveW      = REG_USER_MSG("ReceiveW", 1);

        gmsgCZCareer      = REG_USER_MSG("CZCareer", -1);

        gmsgCZCareerHUD   = REG_USER_MSG("CZCareerHUD", -1);

        gmsgShadowIdx     = REG_USER_MSG("ShadowIdx", 4);

        gmsgTaskTime      = REG_USER_MSG("TaskTime", 4);

        gmsgScenarioIcon  = REG_USER_MSG("Scenario", -1);

        gmsgBotVoice      = REG_USER_MSG("BotVoice", 2);

        gmsgBuyClose      = REG_USER_MSG("BuyClose", 0);

        gmsgSpecHealth2   = REG_USER_MSG("SpecHealth2", 2);

        gmsgBarTime2      = REG_USER_MSG("BarTime2", 4);

        gmsgItemStatus    = REG_USER_MSG("ItemStatus", 1);

        gmsgLocation      = REG_USER_MSG("Location", -1);

        gmsgBotProgress   = REG_USER_MSG("BotProgress", -1);

        gmsgBrass         = REG_USER_MSG("Brass", -1);

        gmsgFog           = REG_USER_MSG("Fog", 7);

        gmsgShowTimer     = REG_USER_MSG("ShowTimer", 0);

        gmsgHudTextArgs   = REG_USER_MSG("HudTextArgs", -1);

}