#include <AwV4.h>
Public Member Functions | |
| unsigned char & | Type () |
| Determine this mover's type. | |
| unsigned int & | Flags () |
| Return the bitfield containing mover options. | |
| short & | LockedPosX () |
| Determine X coordinate of this mover's locked position. | |
| short & | LockedPosY () |
| Determine X coordinate of this mover's locked position. | |
| short & | LockedPosZ () |
| Determine X coordinate of this mover's locked position. | |
| short & | LockedYaw () |
| Determine yaw of this mover's locked position. | |
| short & | LockedPitch () |
| Determine pitch of this mover's locked position. | |
| char & | GlideFactor () |
| Determine this mover's glide factor. | |
| unsigned char & | SpeedFactor () |
| Determine this mover's speed factor. | |
| unsigned char & | FrictionFactor () |
| Determine this mover's friction factor. | |
| char & | AccelTiltX () |
| Determine the X coordinate for 'Roll on Move'. | |
| char & | AccelTiltZ () |
| Determine the Z coordinate for 'Roll on Move'. | |
| unsigned char & | TurnFactor () |
| Determine this mover's turn faxtor. | |
| unsigned char & | AvatarTag () |
| Determine this pick-up item's avatar tag. | |
| SimpleString & | Name () |
| Determine this mover's name. | |
| SimpleString & | SEQ () |
| Determine this mover's SEQ file. | |
| SimpleString & | Script () |
| Determine this mover's script (unused???). | |
| SimpleString & | Sound () |
| Determine this mover's sound effect. | |
| SimpleString & | BumpName () |
| Determine this mover's bump object name. | |
| void | AddWaypoint (Waypoint *wp) |
| void | RemoveWaypoint (Waypoint *&wp) |
| Remove waypoint from this mover. | |
| void | ClearWaypoints () |
| Waypoint * | FirstWaypoint () |
| aw_object_data_mover * | GetObjectData () |
| Create an aw_object_data_camera structure. | |
| Mover () | |
| Default constructor. | |
| void | Assign (const aw_object_data_mover *recv) |
| Assign mover data from an SDK structure. | |
Classes | |
| class | Waypoint |
| Class encapsulating a mover waypoint. More... | |
This class encapsulates a mover object. The methods return references to various fields, which may be used to update them.
For example:
char& glide = mov.GlideFactor();
Will allow you to update the mover's glide factor by assigning a value to the 'glide' reference.
| AwV4::Mover::Mover | ( | ) |
Default constructor.
Constructor which initializes the camera wrapper class.
| unsigned char& AwV4::Mover::Type | ( | ) | [inline] |
Determine this mover's type.
AW_MOVER_TYPE_PASSIVE: "Server Controlled" AW_MOVER_TYPE_ACTIVE: "User Controlled" (default) AW_MOVER_TYPE_ITEM: "Pick-Up Item"
| unsigned int& AwV4::Mover::Flags | ( | ) | [inline] |
Return the bitfield containing mover options.
This value is a bitfield which contains all of the active mover options.
Mover flags are defined in AW_MOVER_FLAGS. Examples follow.
To determine if the 'AW_MOVER_FLAG_SINGLE_RIDER' flag is set:
bool bSingleRider = (mov.Flags() & AW_MOVER_FLAG_SINGLE_RIDER)? true : false;
To remove a flag:
unsigned int& opts = mov.Flags(); opts &= ~AW_MOVER_FLAG_SINGLE_RIDER;
To add a flag:
unsigned int& opts = mov.Flags(); opts |= AW_MOVER_FLAG_SINGLE_RIDER;
| short& AwV4::Mover::LockedPosX | ( | ) | [inline] |
Determine X coordinate of this mover's locked position.
If 'Lock Av Pos' is enabled, this defines the X (West/East) coordinate where the user will be locked.
| short& AwV4::Mover::LockedPosY | ( | ) | [inline] |
Determine X coordinate of this mover's locked position.
If 'Lock Av Pos' is enabled, this defines the Y (height) coordinate where the user will be locked.
| short& AwV4::Mover::LockedPosZ | ( | ) | [inline] |
Determine X coordinate of this mover's locked position.
If 'Lock Av Pos' is enabled, this defines the Z (North/South) coordinate where the user will be locked.
| short& AwV4::Mover::LockedYaw | ( | ) | [inline] |
Determine yaw of this mover's locked position.
If 'Lock Av Pos' is enabled, this defines the yaw (direction) where the user will be locked.
| short& AwV4::Mover::LockedPitch | ( | ) | [inline] |
Determine pitch of this mover's locked position.
If 'Lock Av Pos' is enabled, this defines the avatar pitch where the user will be locked.
| char& AwV4::Mover::GlideFactor | ( | ) | [inline] |
Determine this mover's glide factor.
This determines how much speed the mover will lose when not colliding with the ground or other objects
| unsigned char& AwV4::Mover::SpeedFactor | ( | ) | [inline] |
Determine this mover's speed factor.
This controls how fast the mover will go when under user control.
| unsigned char& AwV4::Mover::FrictionFactor | ( | ) | [inline] |
Determine this mover's friction factor.
This determines how much speed the mover will lose when colliding with the ground or other objects.
| char& AwV4::Mover::AccelTiltX | ( | ) | [inline] |
Determine the X coordinate for 'Roll on Move'.
This is how much the vehicle will lean into (or out of) turns.
| char& AwV4::Mover::AccelTiltZ | ( | ) | [inline] |
Determine the Z coordinate for 'Roll on Move'.
This is how much the vehicle will lean into (or out of) turns.
| unsigned char& AwV4::Mover::TurnFactor | ( | ) | [inline] |
Determine this mover's turn faxtor.
This controls how tightly the mover may turn when under user control.
| unsigned char& AwV4::Mover::AvatarTag | ( | ) | [inline] |
Determine this pick-up item's avatar tag.
If this mover is a pick-up item, this defines the tag where the item will appear on the user's avatar.
| void AwV4::Mover::AddWaypoint | ( | Waypoint * | wp | ) |
Add waypoint to this mover.
| void AwV4::Mover::RemoveWaypoint | ( | Waypoint *& | wp | ) |
Remove waypoint from this mover.
For safety, this requires a reference to the waypoint which will be assigned NULL upon removal.
| void AwV4::Mover::ClearWaypoints | ( | ) |
Remove all waypoints from this mover.
| Waypoint* AwV4::Mover::FirstWaypoint | ( | ) | [inline] |
Retrieve the first waypoint
| aw_object_data_mover * AwV4::Mover::GetObjectData | ( | ) |
Create an aw_object_data_camera structure.
Creates and returns an aw_object_data_camera structure using the data from this wrapper class.
Note that it is up to the caller to appropriately use free() to delete the memory associated with this structure.
| void AwV4::Mover::Assign | ( | const aw_object_data_mover * | recv | ) |
Assign mover data from an SDK structure.
Method which initializes the mover wrapper class from an existing aw_object_data_mover structure.
1.5.1-p1