Prototype/Character: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(0.17)
(Removed old prototype docs)
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
==Basics==
<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/CharacterPrototype.html https://lua-api.factorio.com/latest/prototypes/CharacterPrototype.html]
Prototype type: '''player'''


Entity that you move around on the screen during the campaign and freeplay. Extends [[Prototype/EntityWithHealth]].
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
== Mandatory properties ==
Inherits all properties from [[Prototype/EntityWithHealth]].
 
=== mining_speed ===
'''Type''': [[Types/double]]
 
=== running_speed ===
'''Type''': [[Types/double]]
 
=== distance_per_frame ===
'''Type''': [[Types/double]]
 
=== maximum_corner_sliding_distance ===
'''Type''': [[Types/double]]
 
=== heartbeat ===
'''Type''': [[Types/Sound]]
 
The sound file played when the character's health is low.
 
=== eat ===
'''Type''': [[Types/Sound]]
 
The sound file played when the character eats (fish for example).
 
=== inventory_size ===
'''Type''': [[Types/ItemStackIndex]]
 
=== build_distance ===
'''Type''': [[Types/uint32]]
 
=== drop_item_distance ===
'''Type''': [[Types/uint32]]
 
=== reach_distance ===
'''Type''': [[Types/uint32]]
 
=== reach_resource_distance ===
'''Type''': [[Types/double]]
 
=== item_pickup_distance ===
'''Type''': [[Types/double]]
 
=== loot_pickup_distance ===
'''Type''': [[Types/double]]
 
=== ticks_to_keep_gun ===
'''Type''': [[Types/uint32]]
 
=== ticks_to_keep_aiming_direction ===
'''Type''': [[Types/uint32]]
 
=== ticks_to_stay_in_combat ===
'''Type''': [[Types/uint32]]
 
=== damage_hit_tint ===
'''Type''': [[Types/Color]]
 
=== running_sound_animation_positions ===
'''Type''': [[Types/table]] of [[Types/float]]
 
List of positions in the running animation when the walking sound is played.
    running_sound_animation_positions = {14, 29}
 
=== mining_with_tool_particles_animation_positions ===
'''Type''': [[Types/table]] of [[Types/float]]
 
List of positions in the mining with tool animation when the mining sound and mining particles are created.
    mining_with_tool_particles_animation_positions = {28}
 
=== animations ===
'''Type''': [[Types/table]] of [[Types/CharacterArmorAnimation]]
 
== Optional properties ==
 
=== crafting_categories ===
'''Type''': [[Types/table]] of [[Types/string]]
 
Names of the crafting categories the player can craft recipes from. The built-in categories can be found [[Data.raw#recipe-category|here]]. See also [[Prototype/RecipeCategory]].
 
=== mining_categories  ===
'''Type''': [[Types/table]] of [[Types/string]]
 
Names of the resource categories the player can mine resources from.
 
=== light ===
'''Type''': [[Types/LightDefinition]]
 
=== enter_vehicle_distance ===
'''Type''': [[Types/double]]
 
'''Default''': 3.0
 
Must be >= 0.
 
=== tool_attack_distance ===
'''Type''': [[Types/double]]
 
'''Default''': 1.5
 
=== respawn_time ===
'''Type''': [[Types/uint32]]
 
'''Default''': 10
 
Time in seconds. Must be positive
 
=== character_corpse ===
'''Type''': [[Types/string]]
 
Name of the character corpse that is spawned whend this character dies.
 
=== footstep_particle_triggers ===
 
=== tool_attack_result ===
'''Type''': [[Types/Trigger]]

Latest revision as of 14:32, 25 October 2024

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/CharacterPrototype.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/Character&oldid=202853"