Player Actor

A player actor is a player with a rigid physical body, which is approximated with a capsule and has physical properties. Unlike all other players that can move in any direction, the player actor can only walk on the ground.

The viewing orientation of a player actor in space is defined by 2 angles - theta and phi - and by the up vector that usually coincides with the Z axis:

When changing the theta angle, the vertical view direction of the player actor changes.
When changing the phi angle, the horizontal view direction and the basis of the player actor change.

Player Actor Approximated with Capsule

Notice

As any transformation of a player forces it to recalculate its inner state (position, direction, angles and so on), the up direction of the player's viewport may become "negative forward". And then transformation will be recalculated by using this direction, causing flip of the player's basis. To avoid such flipping, the theta and phi angles should be recalculated by using the current viewing orientation of the player.

If you need a player actor to go up and down a staircase smoothly, without getting stuck on each stair, you should carefully adjust the radius of the capsule that approximates the player. Or you can approximate the staircase with a plane: in this case, the capsule can be of any radius.

The height of the player's capsule should also be set correctly to avoid getting stuck in a doorway.

A player actor can be used to create a first person view. Also a player actor can be used in pair with player persecutor to create a 3rd person view (see the corresponding samples in the SDK).

Physical parameters#

Physical	Toggle on and off the player actor's rigid body. Enabled Physical allows interacting with the environment as a physical object.
Physical Mass	The player actor's physical mass. 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.
Physical Mask	A bit mask defining the player actor's interaction with physicals.
Physics Intersection Mask	A bit mask defining the player actor's physics intersection with other objects.
Collision	Toggle on and off the player actor's ability to collide with other objects.
Collision Mask	A bit mask defining nodes the player actor is able to collide with.
Collision Radius	The radius of the player actor's capsule.
Collision Height	The height of the player actor's capsule.
Min Velocity	The default velocity of the player actor.
Max Velocity	The velocity of the player actor used when the actor runs.
Min Theta	The minimum theta angle (zenith angle, also known as pitch angle) that determines how far upward the player can look.
Max Theta	The maximum theta angle (zenith angle, also known as pitch angle) that determines how far downward the player can look.
Acceleration	The player actor's acceleration.
Damping	The player actor's velocity damping with the time.
Turning	The velocity of the player actor's turning action.
Jumping	The jumping coefficient. The greater the value, the higher the player actor jumps.
Max Step Height	The maximum step height. The value defines the maximum height of a surface to which the player can make a step. It can be used for walking up and down the stairs and stepping over curbs.
Phi	The phi angle (azimuth angle, also known as yaw angle). This angle determines the horizontal viewing direction, i.e. left or right.
Theta	The theta angle (zenith angle, also known as pitch angle). This angle determines the vertical viewing direction, i.e. upward and downward. The value is clamped between the minimum and the maximum theta angle.
View Direction	X, Y, and Z values of the vector defining where the player actor's view is directed.
Ground	A flag indicating that the actor currently stands on the ground surface. This flag is used to set actor state, i.e. play the corresponding skinned animation of standing/walking instead of being in the air.
Ceililng	A value indicating if the actor touches the ceiling surface with its head.
Num Contacts	The number of contacts, in which the player's capsule participates.

In This Article:

See also#

Calculating Collisions#

Creating an Actor#

Editing a Player Actor#

Physical parameters#