This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.
bz shotHasMetaData
| 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. |
Prototype
BZF_API bool bz_shotHasMetaData (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 check |
Description
This API function will return true if the specified shot exists and has data stored under the specified name.
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.