Unigine.PlayerActor Class

Properties:

Name	Description
int NumContacts	The number of contacts, in which the player's capsule participates.
ShapeCapsule Shape	The A shape, which approximates the actor in physical interactions.
Body Body	The A rigid body, if the body is simulated physically (isPhysical(1)); otherwise a dummy body will be returned (isPhysical(0)).
int Ceiling	The A value indicating if the actor touches the ceiling surface with its head.
int Ground	The A flag indicating if the actor currently stands on the ground surface.
vec3 ViewDirection	The current player's view direction vector.
float ThetaAngle	The theta angle (zenith angle, also known as pitch angle).
float PhiAngle	The phi angle (azimuth angle, also known as yaw angle).
float MaxStepHeight	The maximum height of a surface to which the player can make a step.
float Jumping	The current jumping coefficient.
float Turning	The A velocity of player turning.
float Damping	The Actor's velocity damping with the time.
float Acceleration	The current acceleration of the actor.
float MaxThetaAngle	The maximum theta angle (zenith angle, also known as pitch angle) that determines how far downward the player can look.
float MinThetaAngle	The minimum theta angle (zenith angle, also known as pitch angle) that determines how far upward the player can look.
float MaxVelocity	The velocity of the actor, which is used while the actor runs.
float MinVelocity	The default velocity of the actor.
float MaxFriction	The friction value set for the actor that is used when the actor doesn't move, i.
float MinFriction	The friction value set for the actor that is used when the actor walks upon the ground.
float CollisionHeight	The height of actor's capsule.
float CollisionRadius	The radius of actor's capsule.
int CollisionMask	The collision mask of the actor.
int Collision	The A value indicating if collisions with a player's capsule should be taken into account.
int PhysicsIntersectionMask	The A physics intersection mask for a player.
int PhysicalMask	The bit mask for interaction with physicals.
float PhysicalMass	The current mass of the actor.
bool Physical	The A value indicating whether the actor interacts with the environment as a physical object or not.

Methods:

Name	Description View: Sort by:
PlayerActor	Constructor.
GetContactDepth	Returns penetration depth by the given contact.
GetContactNormal	Returns a normal of the contact point, in world coordinates.
GetContactObject	Returns an object participating in the contact with the player (used for collisions with physical object).
GetContactPoint	Returns world coordinates of the contact point.
GetContactShape	Returns a shape that collided with the player's capsule.
GetContactSurface	Returns the surface of the current object, which is in contact (used for collisions with non-physical object).
GetState	Returns a value indicating if the actor is in a given state.
GetStateTime	Returns time spent by the actor in a given state.
type	Returns the type of the player.

Variables:

Name	Description
NUM_STATES = 13
STATE_BACKWARD = 1	A state, in which the player moves backwards.
STATE_BEGIN = 2	A state, which denotes a beginning of another state like moving forward.
STATE_CROUCH = 8	A state, in which the player crouches.
STATE_DISABLED = 0	A state, which means that another state is disabled.
STATE_ENABLED = 1	A state, which means that another state is enabled.
STATE_END = 3	A state, which denotes an end of another state.
STATE_FIRE = 12	A state, in which the player fires their weapon.
STATE_FORWARD = 0	A state, in which the player moves forwards.
STATE_JUMP = 9	A state, in which the player jumps.
STATE_MOVE_LEFT = 2	A state, in which the player moves left.
STATE_MOVE_RIGHT = 3	A state, in which the player moves right.
STATE_RUN = 10	A state, in which the player runs.
STATE_TURN_DOWN = 5	A state, in which the player turns down.
STATE_TURN_LEFT = 6	A state, in which the player turns left.
STATE_TURN_RIGHT = 7	A state, in which the player turns right.
STATE_TURN_UP = 4	A state, in which the player turns up.
STATE_USE = 11	A state, in which the player utilizes some object.

PlayerActor Class

Properties

int NumContacts#

The number of contacts, in which the player's capsule participates.

ShapeCapsule Shape#

The A shape, which approximates the actor in physical interactions.

Body Body#

The A rigid body, if the body is simulated physically (isPhysical(1)); otherwise a dummy body will be returned (isPhysical(0)).

int Ceiling#

The A value indicating if the actor touches the ceiling surface with its head.

int Ground#

The A flag indicating if the actor currently stands on the ground surface. this flag is used to determine the actor state, i.e. play the corresponding skinned animation of standing/walking instead of being in the air.

vec3 ViewDirection#

The current player's view direction vector.

float ThetaAngle#

The theta angle (zenith angle, also known as pitch angle). this angle determines the vertical viewing direction, i.e. upwards or downwards. if a positive value is returned, the player looks upwards; if a negative value is returned, the player looks downwards. the value is clamped between the minimum and the maximum theta angle.

float PhiAngle#

The phi angle (azimuth angle, also known as yaw angle). this angle determines the horizontal viewing direction, i.e. left or right. positive values rotate the player right; negative values rotate the player left.

float MaxStepHeight#

The maximum height of a surface to which the player can make a step.

float Jumping#

The current jumping coefficient.

float Turning#

The A velocity of player turning.

float Damping#

The Actor's velocity damping with the time.

float Acceleration#

The current acceleration of the actor.

float MaxThetaAngle#

The maximum theta angle (zenith angle, also known as pitch angle) that determines how far downward the player can look. the higher the value, the further down the player can look.

float MinThetaAngle#

The minimum theta angle (zenith angle, also known as pitch angle) that determines how far upward the player can look. the lower the value, the further up the player can look.

float MaxVelocity#

The velocity of the actor, which is used while the actor runs.

float MinVelocity#

The default velocity of the actor.

float MaxFriction#

The friction value set for the actor that is used when the actor doesn't move, i.e. stands still on the ground. see also getMinFriction().

float MinFriction#

The friction value set for the actor that is used when the actor walks upon the ground. see also getMaxFriction().

float CollisionHeight#

The height of actor's capsule.

float CollisionRadius#

The radius of actor's capsule.

int CollisionMask#

The collision mask of the actor. two objects collide, if they both have matching masks (i.e. at least one bit matches).

int Collision#

The A value indicating if collisions with a player's capsule should be taken into account. this method is valid only in case setPhysical() is set to 0 and does not handle collisions automatically.

int PhysicsIntersectionMask#

The A physics intersection mask for a player.

int PhysicalMask#

The bit mask for interaction with physicals. two objects interact, if they both have matching masks (i.e. at least one bit matches).

float PhysicalMass#

The current mass of the actor. if g (Earth's gravity) equals to 9.8 m/s^2, and 1 unit equals to 1 meter, the mass is measured in kilograms.

bool Physical#

The A value indicating whether the actor interacts with the environment as a physical object or not.

PlayerActor type identifier.

Last update: 2024-12-13

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

Unigine.PlayerActor Class

In This Article:

See Also#

Properties:

Methods:

Variables:

PlayerActor Class

Properties

int NumContacts#

ShapeCapsule Shape#

Body Body#

int Ceiling#

int Ground#

vec3 ViewDirection#

float ThetaAngle#

float PhiAngle#

float MaxStepHeight#

float Jumping#

float Turning#

float Damping#

float Acceleration#

float MaxThetaAngle#

float MinThetaAngle#

float MaxVelocity#

float MinVelocity#

float MaxFriction#

float MinFriction#

float CollisionHeight#

float CollisionRadius#

int CollisionMask#

int Collision#

int PhysicsIntersectionMask#

int PhysicalMask#

float PhysicalMass#

bool Physical#

Members

PlayerActor ( ) #

float GetContactDepth ( int contact ) #

Arguments

Return value

vec3 GetContactNormal ( int contact ) #

Arguments

Return value

Object GetContactObject ( int contact ) #

Arguments

Return value

vec3 GetContactPoint ( int contact ) #

Arguments

Return value

Shape GetContactShape ( int num ) #

Arguments

Return value

int GetContactSurface ( int contact ) #

Arguments

Return value

int GetState ( int arg1 ) #

Arguments

Return value

float GetStateTime ( int arg1 ) #

Arguments

Return value

static int type ( ) #

Return value