bz fireWorldGM

From BZFlagWiki
Revision as of 10:37, 28 June 2012 by 24.255.56.220 (Talk) (Update template to make it look like the other API function pages.)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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.

Prototype[edit]

BZF_API bool bz_fireWorldGM ( int targetPlayerID, float lifetime, float *pos, float tilt, float direction, float dt , bz_eTeamType shotTeam = eRogueTeam );

Parameters[edit]

name type value desription
targetPlayerID int Player to fire the GM at.
lifetime float How long the world weapon will "live".
*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)
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]

Fires a Guided Missile at a player.