bz fireWorldWep

From BZFlagWiki
Jump to: navigation, search
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.

Prototypes[edit]

BZF_API bool bz_fireWorldWep ( const char* flagType, float lifetime, int fromPlayer, float *pos, float tilt, float direction, int shotID , float dt , bz_eTeamType shotTeam = eRogueTeam );

BZF_API bool bz_fireWorldWep ( const char* flagType, float lifetime, int fromPlayer, float *pos, float tilt, float direction, int *shotID , float dt , bz_eTeamType shotTeam = eRogueTeam );

Parameters[edit]

name type value desription
flagType const char* Flag type the world weapon will fire with
lifetime float How long the world weapon will "live".
fromPlayer int Player ID that fired the shot, or BZ_SERVER.
*pos float Position the world weapon will fire from.
tilt float The tilt of the weapon in radians.
direction float The direction of which to fire the world weapon in radians. (rotation)
shotID int (or int * for second version) Shot ID of the world weapon. Each shot is given a unique shot ID for shot tracking. For the second version a pointer to an int that will contain the generated shot ID.
dt float Delay time. How many seconds the weapon waits before firing.
shotTeam bz_eTeamType Team color of the weapon. (Rogue by default)

Description[edit]

This API function will fire w worldweapon at the specified location with the specified parameters.