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 fireWorldWep: Difference between revisions
Jump to navigation
Jump to search
Added missing parameter, Changed page style to match newer pages |
|||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{BZFS_API_Doc}} | {{BZFS_API_Doc}} | ||
{{BZFS_API_Funcs}} | {{BZFS_API_Funcs}} | ||
== | ==Prototypes== | ||
BZF_API bool bz_fireWorldWep ( const char* flagType, float lifetime, int fromPlayer, float *pos, float tilt, float direction, int shotID , float dt ); | 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== | ==Parameters== | ||
{| border="1" cellpadding="20" cellspacing="0" | {| border="1" cellpadding="20" cellspacing="0" | ||
| Line 34: | Line 37: | ||
|- | |- | ||
|shotID | |shotID | ||
|int | |int (or int * for second version) | ||
|Shot ID of the world weapon. Each shot is given a unique shot ID for shot tracking. | |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 | |dt | ||
|float | |float | ||
|Delay time. How many seconds the weapon waits before firing. | |Delay time. How many seconds the weapon waits before firing. | ||
|- | |||
|shotTeam | |||
|bz_eTeamType | |||
|Team color of the weapon. (Rogue by default) | |||
|} | |} | ||
==Description== | ==Description== | ||
This API function will fire w worldweapon at the specified location with the specified parameters. | This API function will fire w worldweapon at the specified location with the specified parameters. | ||
Latest revision as of 18:43, 19 April 2014
| 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
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
| 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
This API function will fire w worldweapon at the specified location with the specified parameters.