Character

Manual / Base Types / 3D / Character

Character

Contents

1 Overview
2 How to create
3 Player control settings
4 Character customization
5 Create a character as a separate file
6 Using a character in a previously created scene as a type
7 Properties
8 See also

Overview

A basic class for characters. An example scene is in 'Samples\Starter Content\Scenes\Character.scene'.

How to create

The character is created like other objects, the easiest way to do this is to drop it into the scene from the Resources Window.

Player control settings

In order to configure character control by a player, you need to configure the properties of the Game Mode object. This object is in the scene. The 'Object Controlled By Player' property should point to the character. You also need to configure the type of camera using the Use 'Built In Camera' property (for example, select First Person).

Now by launching the Player App, you can control the character in a first-person view.

Character customization

The character is customizable using properties and nested components. By default, the character contains a 3D model, a physical body, a component for controlling the player, and artificial intelligence.

Component of 3D model.
A physical body with the name Collision Body.
Character Input Processing adds the ability to control the character by the player.
Character AI for character control by software. It can be used to control the character using commands, to create bots, NPCs.
Weapon which can be taken and activated.

Create a character as a separate file

The character can be configured as a separate file with the extension .character.

You can configure a new character in the scene and then save it to a file by means 'Save To File' item of the context menu.

Using a character in a previously created scene as a type

In order to create character types, it is not necessary to create a .character file. You can use the scene and the character created in it as a type. To do this, select the scene file in the Resources Window and click '+'. In the expanded list there will be scene objects that can be dragged and dropped into another scene.

Properties

Using properties, you can turn on/off certain components of the character, for example, the ability to run. Having changed the 3D model, you will need to change the values of the properties in the Animation group.

Name	Description
Height	The height of the character.
Radius	The radius of the collision capsule.
Walk Up Height	The height to which the character can rise. Set 0 to disable functionality of walking up.
Position To Ground Height	The distance from the character position to the ground.
Mass	The mass of the character.
Max Slope Angle	The maximum angle of the surface on which the character can stand.
Eye Position	The position of the eyes relative to the position of the character.
Apply Ground Velocity	Whether to consider the speed of the body on which the character is standing.
Linear Damping On Ground Idle	The value of linear dumping when a character is standing on the ground.
Linear Damping On Ground Move	The value of linear dumping when a character is standing on the ground.
Linear Damping Fly	The value of linear dumping when a character is flying.
Walk Forward Max Speed	Maximum speed when walking forward.
Walk Backward Max Speed	Maximum speed when walking backward.
Walk Side Max Speed	Maximum speed when walking to a side.
Walk Force	Physical force applied to the body for walking.
Run Support	Can the character run.
Run Forward Max Speed	Maximum speed when running forward.
Run Backward Max Speed	Maximum speed when running backward.
Run Side Max Speed	Maximum speed when running to a side.
Run Force	Physical force applied to the body for running.
Turning Speed	The speed of rotation of the character around its axis.
Fly Control Support	Can a character control himself in flight.
Fly Control Max Speed	Maximum speed of character control in flight.
Fly Control Force	Physical force applied to the body for flying.
Jump Support	Can the character jump.
Jump Speed	The vertical speed of a jump.
Animate	Whether to enable default animation method of the character.
Idle Animation	Animation of character at rest.
Walk Animation	Character walking animation.
Walk Animation Speed	The multiplier for playing the walking animation depending on the speed of the character.
Run Animation	Character running animation.
Run Animation Speed	The multiplier for playing the running animation depending on the speed of the character.
Fly Animation	Character flying animation.
Jump Animation	Character jump animation.
Left Turn Animation	Character left turn animation.
Right Turn Animation	Character left turn animation.
Left Hand Bone	The name of the left hand bone.
Left Hand Factor	Left hand control ratio.
Left Hand Transform	Left hand target transform in the world coordinates. X - forward, -Z - palm.
Right Hand Bone	The name of the right hand bone.
Right Hand Factor	Right hand control ratio.
Right Hand Transform	Right hand target transform in the world coordinates. X - forward, -Z - palm.
Head Bone	The name of the head body.
Head Factor	Head control ratio.
Head Look At	Target position of the head.
Health	The health of the character.