Difference between revisions of "Bz fireWorldGM"

From BZFlagWiki
Jump to: navigation, search
(dt = delay time)
(Update template to make it look like the other API function pages.)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{apicall
+
{{BZFS_API_Doc}}
| name          = bz_fireWorldGM
+
{{BZFS_API_Funcs}}
| description  = Fires a Guided Missile at a player.
+
==Prototype==
| param1        = targetPlayerID
+
BZF_API bool bz_fireWorldGM ( int targetPlayerID, float lifetime, float *pos, float tilt, float direction, float dt , bz_eTeamType shotTeam = eRogueTeam );
| param1type    = int
+
 
| param1desc    = Player to fire the GM at.
+
==Parameters==
| param2        = lifetime
+
{| border="1" cellpadding="20" cellspacing="0"
| param2type    = float
+
  !name
| param2desc    = How long the world weapon will "live".
+
  !type
| param3        = *pos
+
  !value desription
| param3type    = float
+
  |-
| param3desc    = Position the world weapon will fire from.
+
  |targetPlayerID
| param4        = tilt
+
  |int
| param4type    = float
+
  |Player to fire the GM at.
| param4desc    = The tilt of the weapon.
+
  |-
| param5        = direction
+
  |lifetime
| param5type    = float
+
  |float
| param5desc    = The direction of which to fire the world weapon. (rotation)
+
  |How long the world weapon will "live".
| param6        = dt
+
  |-
| param6type    = float
+
  |*pos  
| param6desc    = Delay time. How many seconds to wait before firing the GM.
+
  |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==
 +
Fires a Guided Missile at a player.

Latest revision as of 10:37, 28 June 2012

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.