This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz fireWorldWep"
From BZFlagWiki
(Add some more information) |
(Added missing parameter, Changed page style to match newer pages) |
||
Line 1: | Line 1: | ||
− | {{ | + | {{BZFS_API_Doc}} |
− | + | {{BZFS_API_Funcs}} | |
− | + | ==Prototype== | |
− | | | + | BZF_API bool bz_fireWorldWep ( const char* flagType, float lifetime, int fromPlayer, float *pos, float tilt, float direction, int shotID , float dt ); |
− | | | + | ==Parameters== |
− | | | + | {| border="1" cellpadding="20" cellspacing="0" |
− | | | + | !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 | ||
+ | |Shot ID of the world weapon. Each shot is given a unique shot ID for shot tracking. | ||
+ | |- | ||
+ | |dt | ||
+ | |float | ||
+ | |Delay time. How many seconds the weapon waits before firing. | ||
+ | |} | ||
+ | |||
+ | ==Description== | ||
+ | This API function will fire w worldweapon at the specified location with the specified parameters. |
Revision as of 01:22, 1 July 2011
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_fireWorldWep ( const char* flagType, float lifetime, int fromPlayer, float *pos, float tilt, float direction, int shotID , float dt );
Parameters
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 | Shot ID of the world weapon. Each shot is given a unique shot ID for shot tracking. |
dt | float | Delay time. How many seconds the weapon waits before firing. |
Description
This API function will fire w worldweapon at the specified location with the specified parameters.