Ping Button is an unofficial quality of life addon which allows players to ping locations in lieu of using voice chat functions.

Recently introduced to the addon is the ability to mark players using its “alert” type ping, which will show an additional mugshot alongside the ping. This page will detail the few steps needed to make sure that your classes will be able to show that mugshot.

Giving Notice

Ping Button’s class support works first off of a notice system. When it attempts to draw an icon for any class, it’ll first check for the existence of a DECORATE actor using a naming scheme of PBMug_[ActorClassName], where [ActorClassName] is the actor name of your class. Below are a few examples of this style of actor being defined.

actor PBMug_MegamanC {}
actor PBMug_Protoman {}
actor PBMug_Bass {}
actor PBMug_Duo {}
actor PBMug_Maestro {}
actor PBMug_RockClass {}
actor PBMug_RollClass {}
actor PBMug_AutoClass {}
actor PBMug_LightRyu {}
actor PBMug_DrWily {}
actor PBMug_SniperJoe {}

Getting the Graphic Name

Once Ping Button finds that DECORATE actor, it’ll attempt to execute an ACS script with the exact same naming scheme of PBMug_[ActorClassName]. This’ll be a script that you implement in your class’s file. All the script needs to do is use [SetResultValue](<https://zdoom.org/wiki/SetResultValue>) to return the graphic your class uses for their player.scoreicon property. Below is an example:

script "PBMug_Napalmman" (int tid) CLIENTSIDE { SetResultValue("C_05G0X"); }

When these scripts are called, they are passed a TID parameter which can be used for more advanced logic to determine which mugshot to return. Below is an example of Auto who returns a different mugshot depending on whether or not he’s equipped his helmet.

script "PBMug_AutoClass" (int tid) CLIENTSIDE { 
    if(CheckActorInventory(tid, "AutoEquippedHisHelmet") > 0) {
        SetResultValue("192GRIN");
    } else {
        SetResultValue("C_00G0X");
    }
}

Once both the DECORATE actor and respective script is implemented, you’ll be able to see the pings in action!

Example File

PB-CBMSupport-v1a.pk3

See Also