Skip to Content

bz_eComputeHandicapEvent

This event is called each time the handicap for a player is being calculated. By setting desiredHandicap in your plug-in, you can override the value and calculate the handicap however you'd like.

This event will only occur if the -handicap option is set for BZFS.

Data Object Type

2.4.12 bz_ComputeHandicap_V1

Parameters

These are the values accessible in the bz_EventData variable that's made available in the Event method.

Data Type Name Description
int playerID

The ID of the player whose handicap value is being calculated

int desiredHandicap

The handicap value for the target player

double eventTime

The server time at which the event occurred (in seconds).

Plug-in Usage

There are no plug-ins in the official distribution that make use of this event. Browse the Plug-in Releases forum for plug-ins which may make use of this event.

Plug-in Example

This block of code can be used to get started when implementing the Event() function of your plug-in.

bz_ComputeHandicap_V1* dataObject = (bz_ComputeHandicap_V1*)eventData;

// Data
// ---
// (int)          playerID - The ID of the player whose handicap value is being calculated
// (int)          desiredHandicap - The handicap value for the target player
// (double)       eventTime - The server time at which the event occurred (in seconds).

Other Handicap Events

Back to bzfs API Events

This content is maintained on GitHub. We welcome any feedback and improvements!

Give us Feedback Edit this Page