This wiki is archived and useful information is being migrated to the main bzflag.org website
bz getShotMetaData
| BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server. |
| BZFS API Function. This page documents a BZFS_API Function, that is provided by the BZFS game server for plug-ins to call. |
Contents
Prototype
BZF_API uint32_t bz_getShotMetaData (int fromPlayer, int shotID, const char* name);
Parameters
| name | type | value desription |
|---|---|---|
| fromPlayer | int | the player who owns the shot, BZ_SERVER for world weapons |
| shotID | int | the local ID of the shot for the specified player |
| name | const char* | the name of the MetaData value to get |
Description
This API function will return the data associated with the specified name for the specified shot. If the shot does not exist, or does not have any data for the name the function will return 0
Notes
Shot MetaData is useful for plug-ins that need to fake extra player shots with server based world weapons. Using MetaData a plug-in can store player or score information with the shot to be used later when the shot hits a target or expires. Shot MetaData is server side only and is unique to each shot fired. Multiple shots with the same ID over time will not contain the same data.
