DtScriptWeaponInfo Class Reference

This class is a wrapper for a DtCompSystem for use by scripts. It derives from DtAsciiSerializable so that it can provide serialization functions for script saving/reloading.

Inheritance diagram for DtScriptWeaponInfo:

Public Member Functions
	DtScriptWeaponInfo (const DtLocalObject *vrfObject)
	DtScriptWeaponInfo (const DtScriptWeaponInfo &orig)
DtScriptWeaponInfo &	operator= (const DtScriptWeaponInfo &orig)
	~DtScriptWeaponInfo ()
bool	operator== (const DtScriptWeaponInfo &orig)
Public Member Functions inherited from DtAsciiSerializable
	DtAsciiSerializable ()
	DtAsciiSerializable (const DtAsciiSerializable &orig)
virtual	~DtAsciiSerializable ()
virtual std::string	objectTypeC () const
virtual void	init (void *userData)

Private Member Functions
	DtScriptWeaponInfo ()
const DtSimulationServices *	mySimServices
const DtLocalObject *	myObject
const DtWeaponInfoInterface *	myWeaponInfo
std::string	myWeaponId
bool	isValid () const
void	setWeaponInfo (const DtString &weaponId, const DtWeaponInfoInterface *weaponInfo)
std::string	weaponId () const
std::string	getDisplayName () const
bool	isReady () const
int	getStatus () const
std::string	getStatusString () const
int	getTurret () const
bool	getControlExternalTurret () const
std::list< std::string >	getFireTasks () const
std::list< std::string >	getResourceNames () const
bool	canTargetLocation (const DtLocation3D &location) const
int	targetApplicability (const std::string &targetType) const
luabind::object	createFireTask (lua_State *L, luabind::object const &luaLocationRef) const
bool	isAutonomousFire () const
bool	isAutonomousFireType (const std::string &targetType) const
luabind::object	weaponProperty (lua_State *L, const std::string &propertyName) const
bool	isBlockedByOtherWeapon (std::string &blockingWeaponId) const
bool	conflictsWithOtherWeapon (const std::string &otherWeaponId) const
virtual DtString	serialize () override
virtual void	init (const DtSimulationServices *, DtLocalObject *owner)
virtual bool	deserialize (const DtString &data) override
virtual DtString	objectType () const override
static DtAsciiSerializable *	creator ()
void	throwIfNotValid () const

Constructor & Destructor Documentation

DtScriptWeaponInfo::DtScriptWeaponInfo ( )

private

Hide the default constructor so we always get a vrfObject to use.

DtScriptWeaponInfo::DtScriptWeaponInfo

(

const DtLocalObject *

vrfObject

)

DtScriptWeaponInfo::DtScriptWeaponInfo

(

const DtScriptWeaponInfo &

orig

)

DtScriptWeaponInfo::~DtScriptWeaponInfo

(

)

Member Function Documentation

DtScriptWeaponInfo& DtScriptWeaponInfo::operator=

(

const DtScriptWeaponInfo &

orig

)

bool DtScriptWeaponInfo::operator==

(

const DtScriptWeaponInfo &

orig

)

bool DtScriptWeaponInfo::isValid

(

)

const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

void DtScriptWeaponInfo::setWeaponInfo	(	const DtString &	weaponId,
		const DtWeaponInfoInterface *	weaponInfo
	)

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

std::string DtScriptWeaponInfo::weaponId

(

)

const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

std::string DtScriptWeaponInfo::getDisplayName

(

)

const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

bool DtScriptWeaponInfo::isReady

(

)

const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

int DtScriptWeaponInfo::getStatus

(

)

const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

std::string DtScriptWeaponInfo::getStatusString

(

)

const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

int DtScriptWeaponInfo::getTurret

(

)

const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

bool DtScriptWeaponInfo::getControlExternalTurret

(

)

const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

std::list<std::string> DtScriptWeaponInfo::getFireTasks

(

)

const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

std::list<std::string> DtScriptWeaponInfo::getResourceNames

(

)

const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

bool DtScriptWeaponInfo::canTargetLocation

(

const DtLocation3D &

location

)

const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

int DtScriptWeaponInfo::targetApplicability

(

const std::string &

targetType

)

const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

luabind::object DtScriptWeaponInfo::createFireTask	(	lua_State *	L,
		luabind::object const &	luaLocationRef
	)		const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

bool DtScriptWeaponInfo::isAutonomousFire

(

)

const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

bool DtScriptWeaponInfo::isAutonomousFireType

(

const std::string &

targetType

)

const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

luabind::object DtScriptWeaponInfo::weaponProperty	(	lua_State *	L,
		const std::string &	propertyName
	)		const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

bool DtScriptWeaponInfo::isBlockedByOtherWeapon

(

std::string &

blockingWeaponId

)

const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

bool DtScriptWeaponInfo::conflictsWithOtherWeapon

(

const std::string &

otherWeaponId

)

const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

virtual DtString DtScriptWeaponInfo::serialize ( )

overridevirtual

Inherited from DtAsciiSerializable. Returns a string serialized version of this class.

Implements DtAsciiSerializable.

virtual void DtScriptWeaponInfo::init ( const DtSimulationServices *  , DtLocalObject *  owner  )

virtual

Called after object is constructed, but before deserialize() is called, during deserialization (scenario and script reload). The Lua scenario loader constructs this object, then calls init with the SimManager as the argument; init saves this in mySimManager.

virtual bool DtScriptWeaponInfo::deserialize ( const DtString &  data )

overridevirtual

Inherited from DtAsciiSerializable. Returns true if it could fill its members with the data contained in the string. False otherwise.

Implements DtAsciiSerializable.

virtual DtString DtScriptWeaponInfo::objectType ( ) const

overridevirtual

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

Implements DtAsciiSerializable.

static DtAsciiSerializable* DtScriptWeaponInfo::creator ( )

static

Inherited from DtAsciiSerializable. Returns a new object of this type with.

void DtScriptWeaponInfo::throwIfNotValid ( ) const

protected

Returns the vrf object referenced by myObject

DtVrfObject* vrfObject() const;

Checks validity and throws a runtime error if not valid.

Member Data Documentation

const DtSimulationServices* DtScriptWeaponInfo::mySimServices

protected

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

const DtLocalObject* DtScriptWeaponInfo::myObject

protected

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

const DtWeaponInfoInterface* DtScriptWeaponInfo::myWeaponInfo

protected

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

std::string DtScriptWeaponInfo::myWeaponId

protected

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

---

The documentation for this class was generated from the following file:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfLua/scriptWeaponInfo.h