Written with version 1.5.7
To support taking off / landing, you must create 2 versions of your plane. The first version is the landed version, the second is airborne.
local aircraftMaker = require("__AircraftRealism__.aircraftMaker")
aircraftMaker.<your desired function>Reserved for internal use, do not modify them when after calling makeGrounded()
| Prototype member |
|---|
| collision_mask |
| consumption |
| effectivity |
| name |
| max_health |
| order |
| repair_speed_modifier |
| tank_driving |
Can be called from data.lua, data-updates.lua, or data-final-fixes.lua.
makeGrounded must be called before makeAirborne.
void makeGrounded(Table config)| Config member | Type | Documentation |
|---|---|---|
| isSeaplane | bool | Default: false If true, plane can land on water tiles. If false, plane destroyed upon landing on water |
| prototype | prototype | Your plane prototype, already registered to global table data |
-- Example
local aircraftMaker = require("__AircraftRealism__.aircraftMaker")
local groundedGunship = data.raw["car"]["gunship"]
aircraftMaker.makeGrounded({
isSeaplane = false,
prototype = groundedGunship
})Prototype makeAirborne(Table config)| Config member | Type | Documentation |
|---|---|---|
| name | string | Prototype name used in makeGrounded |
| maxSpeed? | number | Maximum speed of the airborne plane, cannot accelerate past this (tiles/tick) |
| shadow? | table | Define to enable to plane to have animated shadows |
| shadow.directionCount | number | Number of directions in total on the spritesheet |
| shadow.endSpeed | number | Speed after plane transition speed to end the shadow animation (tiles/tick) |
| shadow.tileOffsetFinal? | {number, number} | Default: {50, 20} The shadow will move from its initial position to this at the end of the shadow animation |
| shadow.renderLayer? | string | Default: "smoke" One of Types/Renderlayer |
| shadow.alphaInitial? | number | Default: 0.5 Shadow tint begins with this alpha and falls to 0 |
| shadow.lineLength? | number | Number of directions per row within the spritesheet |
| shadow.filename? | string | Filename to shadow spritesheet of the plane |
| shadow.hrFilename? | string | Filename to HR shadow spritesheet of the plane |
| shadow.width? | number | Number of pixels for each sprite direction within the spritesheet (width) |
| shadow.hrWidth? | number | Number of pixels for each sprite direction within the HR spritesheet (width) |
| shadow.height? | number | Number of pixels for each sprite direction within the spritesheet (height) |
| shadow.hrHeight? | number | Number of pixels for each sprite direction within the HR spritesheet (height) |
| shadow.shift? | {number, number} | Default: {0, 0} Same as Factorio sprite.shift |
| shadow.hrShift? | {number, number} | Default: {0, 0} Same as Factorio sprite.shift for HR sprite |
| shadow.scale? | number | Default: 1 Same as Factorio sprite.scale |
| shadow.hrScale? | number | Default: 1 Same as Factorio sprite.scale for HR sprite |
Return
Returns the prototype of the created airborne plane.
Making Shadows
Animated shadows for the plane is enabled if shadow is defined. There are two options to define shadow sprites, using makeAirborne or manually.
If using makeAirborne, provide the sprite information such as shadow.filename, shadow.width and shadow.height.
If defining shadows manually, there needs to be shadow.directionCount shadows corresponding to each orientation, obeying orthogonal projection. Orientations start from north, rotating clockwise. The sprites must be named as "name-airborne-shadow-index", where name is the name provided to makeAirborne and index is in range [0, config.shadow.directionCount - 1] corresponding to each orientation.
-- Example
local aircraftMaker = require("__AircraftRealism__.aircraftMaker")
local gunship = aircraftMaker.makeAirborne({
name="gunship",
shadow={
filename="__Aircraft__/graphics/entity/gunship/gunship_spritesheet-shadow.png",
width = 224,
height = 224,
shift = util.by_pixel(54, 35),
hrFilename="__Aircraft__/graphics/entity/gunship/hr-gunship_spritesheet-shadow.png",
hrWidth = 448,
hrHeight = 448,
hrShift = util.by_pixel(54, 35),
hrScale = 0.5,
lineLength = 6,
directionCount = 36,
endSpeed = 60 / 216
}
})Adjust the behavior your plane based on user configuration values such as realistic turn radius, acceleration, ...
Table getSettings()The values of all members is a true/false.
| Member | Recommended changes to apply |
|---|---|
| rAcceleration | Increase prototype weight. Reduce prototype friction for gliding |
| rBraking | Reduce braking power |
| rTurnRadius | Decrease prototype rotation_speed |
| noAerialShadow | Kept for backward compatibility, always true. Original: Remove shadows from airborne plane |
-- Example
local aircraftMaker = require("__AircraftRealism__.aircraftMaker")
local settings = aircraftMaker.getSettings()
if settings.rAcceleration then
-- ...
end
if settings.rBraking then
-- ...
end
if settings.rTurnRadius then
-- ...
endAdd settings in settings.lua, settings-updates.lua, or settings-final-fixes.lua
<yourPlaneName> is the prototype name of your plane
data:extend({
{
type = "double-setting",
name = "aircraft-takeoff-speed-<yourPlaneName>",
setting_type = "runtime-global",
minimum_value = 10,
maximum_value = <reasonable limit>
default_value = 110,
},
-- ...
})If you defined maxSpeed for your plane, the maximum value must be less than the maxSpeed.
Your plane prototype is duplicated for the airborne version, possessing the suffix -airborne
<yourPlaneName> is the prototype name of your plane
[entity-name]
<yourPlaneName>=Your Plane Name
<yourPlaneName>-airborne=Your Plane Name
[entity-description]
<yourPlaneName>=Description of your plane
<yourPlaneName>-airborne=Description of your plane
[mod-setting-name]
aircraft-takeoff-speed-<yourPlaneName>=Takeoff speed
[mod-setting-description]
aircraft-takeoff-speed-<yourPlaneName>=Speed to takeoff and be airborne, no longer colliding with anythingTurn the vanilla car into a flying one.
See FlyingCar_0.1.0, works as a standalone mod.