CSWFireCommand Class Reference

Inheritance diagram for CSWFireCommand:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual ARSTD::Command::PtrType copy () const

Static Public Member Functions

static PtrType create (boost::shared_ptr< CSWWeaponBattery > &pWeaponBattery, double fArmDelay=5.0, boost::shared_ptr< CSWWeapon > &pWeapon=boost::shared_ptr< CSWWeapon >())

Detailed Description

This is a specialization of a command. It provides the functionality to launch a Weapon from a WeaponBattery.


Member Function Documentation

CSWFireCommand::PtrType CSWFireCommand::create ( boost::shared_ptr< CSWWeaponBattery > &  pWeaponBattery,
double  fArmDelay = 5.0,
boost::shared_ptr< CSWWeapon > &  pWeapon = boost::shared_ptr< CSWWeapon >() 
) [static]

Creates a new fire command. If no Weapon is loaded to the WeaponBattery nothing will be done.

Parameters:
pWeaponBattery The WeaponBattery from where the Weapon should be launched.
fArmDelay The time in seconds when the weapon should be armed.
pWeapon The Weapon that will be launched. If the given Weapon is not found nothing will be done. If None is given the next available Weapon will be launched. (by default None)
Returns:
Returns the new constructed command.

ARSTD::Command::PtrType CSWFireCommand::copy (  )  const [virtual]

Returns a copy of the command.

Returns:
The copied command.

Implements ARSTD::Command.


Generated at 2 Jan 2007 for project CodeSubWars. www.codesubwars.org