CharacterPrototype

Entity that you move around on the screen during the campaign and freeplay.

Parent

• EntityWithOwnerPrototype

Properties

crafting_speed

• Type: double
• Optional: true
• Override: false

mining_speed

• Type: double
• Optional: false
• Override: false

running_speed

• Type: double
• Optional: false
• Override: false

distance_per_frame

• Type: double
• Optional: false
• Override: false

maximum_corner_sliding_distance

• Type: double
• Optional: false
• Override: false

heartbeat

• Type: Sound
• Optional: true
• Override: false

The sound played when the character's health is low.

inventory_size

• Type: ItemStackIndex
• Optional: false
• Override: false

Number of slots in the main inventory. May be 0.

guns_inventory_size

• Type: ItemStackIndex
• Optional: true
• Override: false

Must be between 1 and 15.

build_distance

• Type: uint32
• Optional: false
• Override: false

drop_item_distance

• Type: uint32
• Optional: false
• Override: false

reach_distance

• Type: uint32
• Optional: false
• Override: false

reach_resource_distance

• Type: double
• Optional: false
• Override: false

item_pickup_distance

• Type: double
• Optional: false
• Override: false

loot_pickup_distance

• Type: double
• Optional: false
• Override: false

ticks_to_keep_gun

• Type: uint32
• Optional: false
• Override: false

ticks_to_keep_aiming_direction

• Type: uint32
• Optional: false
• Override: false

ticks_to_stay_in_combat

• Type: uint32
• Optional: false
• Override: false

damage_hit_tint

• Type: Color
• Optional: false
• Override: false

mining_with_tool_particles_animation_positions

• Type: Array<float>
• Optional: false
• Override: false

List of positions in the mining with tool animation when the mining sound and mining particles are created.

Examples

mining_with_tool_particles_animation_positions = {28}

running_sound_animation_positions

• Type: Array<float>
• Optional: false
• Override: false

List of positions in the running animation when the walking sound is played.

Examples

running_sound_animation_positions = {14, 29}

moving_sound_animation_positions

• Type: Array<float>
• Optional: false
• Override: false

animations

• Type: Array<CharacterArmorAnimation>
• Optional: false
• Override: false

crafting_categories

• Type: Array<RecipeCategoryID>
• Optional: true
• Override: false

Names of the crafting categories the character can craft recipes from. The built-in categories can be found here. See also RecipeCategory.

mining_categories

• Type: Array<ResourceCategoryID>
• Optional: true
• Override: false

Names of the resource categories the character can mine resources from.

light

• Type: LightDefinition
• Optional: true
• Override: false

flying_bob_speed

• Type: float
• Optional: true
• Override: false

grounded_landing_search_radius

• Type: double
• Optional: true
• Override: false

The search radius for a non-colliding position to move the player to if they are grounded mid-flight. Must be >= 0.

enter_vehicle_distance

• Type: double
• Optional: true
• Override: false

Must be >= 0.

tool_attack_distance

• Type: double
• Optional: true
• Override: false

respawn_time

• Type: uint32
• Optional: true
• Override: false

Time in seconds. Must be positive

has_belt_immunity

• Type: boolean
• Optional: true
• Override: false

Whether this character is moved by belts when standing on them.

character_corpse

• Type: EntityID
• Optional: true
• Override: false

Name of the character corpse that is spawned when this character dies.

flying_collision_mask

• Type: CollisionMaskConnector
• Optional: true
• Override: false

This collision mask is used when the character is flying.

Defaults to the mask from UtilityConstants::default_collision_masks when indexed by "character/flying".

tool_attack_result

• Type: Trigger
• Optional: true
• Override: false

footstep_particle_triggers

• Type: FootstepTriggerEffectList
• Optional: true
• Override: false

Triggered every tick of the running animation.

synced_footstep_particle_triggers

• Type: FootstepTriggerEffectList
• Optional: true
• Override: false

Triggered when the running animation (animations) rolls over the frames defined in right_footprint_frames and left_footprint_frames.

footprint_particles

• Type: Array<FootprintParticle>
• Optional: true
• Override: false

Triggered when the running animation (animations) rolls over the frames defined in right_footprint_frames and left_footprint_frames.

left_footprint_offset

• Type: Vector
• Optional: true
• Override: false

Offset from the center of the entity for the left footprint. Used by footprint_particles.

right_footprint_offset

• Type: Vector
• Optional: true
• Override: false

Offset from the center of the entity for the right footprint. Used by footprint_particles.

right_footprint_frames

• Type: Array<float>
• Optional: true
• Override: false

The frames in the running animation (animations) where the right foot touches the ground.

left_footprint_frames

• Type: Array<float>
• Optional: true
• Override: false

The frames in the running animation (animations) where the left foot touches the ground.

is_military_target

• Type: boolean
• Optional: true
• Override: true

Whether this prototype should be a high priority target for enemy forces. See Military units and structures.