PrototypeBase - Prototype Docs

Home / Prototypes / PrototypeBase <>

PrototypeBase - abstract

The abstract base for prototypes. PrototypeBase defines the common features of prototypes, such as localization and order.

Children

AchievementPrototype - 'achievement'
- BuildEntityAchievementPrototype - 'build-entity-achievement'
- CombatRobotCountAchievementPrototype - 'combat-robot-count'
- ConstructWithRobotsAchievementPrototype - 'construct-with-robots-achievement'
- DeconstructWithRobotsAchievementPrototype - 'deconstruct-with-robots-achievement'
- DeliverByRobotsAchievementPrototype - 'deliver-by-robots-achievement'
- DontBuildEntityAchievementPrototype - 'dont-build-entity-achievement'
- DontCraftManuallyAchievementPrototype - 'dont-craft-manually-achievement'
- DontUseEntityInEnergyProductionAchievementPrototype - 'dont-use-entity-in-energy-production-achievement'
- FinishTheGameAchievementPrototype - 'finish-the-game-achievement'
- GroupAttackAchievementPrototype - 'group-attack-achievement'
- KillAchievementPrototype - 'kill-achievement'
- PlayerDamagedAchievementPrototype - 'player-damaged-achievement'
- ProduceAchievementPrototype - 'produce-achievement'
- ProducePerHourAchievementPrototype - 'produce-per-hour-achievement'
- ResearchAchievementPrototype - 'research-achievement'
- TrainPathAchievementPrototype - 'train-path-achievement'
AmmoCategory - 'ammo-category'
AutoplaceControl - 'autoplace-control'
CustomInputPrototype - 'custom-input'
DamageType - 'damage-type'
DecorativePrototype - 'optimized-decorative'
EntityPrototype - abstract
- ArrowPrototype - 'arrow'
- ArtilleryFlarePrototype - 'artillery-flare'
- ArtilleryProjectilePrototype - 'artillery-projectile'
- BeamPrototype - 'beam'
- CharacterCorpsePrototype - 'character-corpse'
- CliffPrototype - 'cliff'
- CorpsePrototype - 'corpse'
  - RailRemnantsPrototype - 'rail-remnants'
- DeconstructibleTileProxyPrototype - 'deconstructible-tile-proxy'
- EntityGhostPrototype - 'entity-ghost'
- EntityParticlePrototype - 'particle'
  - LeafParticlePrototype - 'leaf-particle'
- EntityWithHealthPrototype - abstract
  - EntityWithOwnerPrototype - abstract
    - AccumulatorPrototype - 'accumulator'
    - ArtilleryTurretPrototype - 'artillery-turret'
    - BeaconPrototype - 'beacon'
    - BoilerPrototype - 'boiler'
    - BurnerGeneratorPrototype - 'burner-generator'
    - CharacterPrototype - 'character'
    - CombinatorPrototype - abstract
      - ArithmeticCombinatorPrototype - 'arithmetic-combinator'
      - DeciderCombinatorPrototype - 'decider-combinator'
    - ConstantCombinatorPrototype - 'constant-combinator'
    - ContainerPrototype - 'container'
      - LogisticContainerPrototype - 'logistic-container'
        
        InfinityContainerPrototype - 'infinity-container'
    - CraftingMachinePrototype - abstract
      - AssemblingMachinePrototype - 'assembling-machine'
        
        RocketSiloPrototype - 'rocket-silo'
      - FurnacePrototype - 'furnace'
    - ElectricEnergyInterfacePrototype - 'electric-energy-interface'
    - ElectricPolePrototype - 'electric-pole'
    - EnemySpawnerPrototype - 'unit-spawner'
    - FlyingRobotPrototype - abstract
      - CombatRobotPrototype - 'combat-robot'
      - RobotWithLogisticInterfacePrototype - abstract
        
        ConstructionRobotPrototype - 'construction-robot'
        
        LogisticRobotPrototype - 'logistic-robot'
    - GatePrototype - 'gate'
    - GeneratorPrototype - 'generator'
    - HeatInterfacePrototype - 'heat-interface'
    - HeatPipePrototype - 'heat-pipe'
    - InserterPrototype - 'inserter'
    - LabPrototype - 'lab'
    - LampPrototype - 'lamp'
    - LandMinePrototype - 'land-mine'
    - LinkedContainerPrototype - 'linked-container'
    - MiningDrillPrototype - 'mining-drill'
    - OffshorePumpPrototype - 'offshore-pump'
    - PipePrototype - 'pipe'
      - InfinityPipePrototype - 'infinity-pipe'
    - PipeToGroundPrototype - 'pipe-to-ground'
    - PlayerPortPrototype - 'player-port'
    - PowerSwitchPrototype - 'power-switch'
    - ProgrammableSpeakerPrototype - 'programmable-speaker'
    - PumpPrototype - 'pump'
    - RadarPrototype - 'radar'
    - RailPrototype - abstract
      - CurvedRailPrototype - 'curved-rail'
      - StraightRailPrototype - 'straight-rail'
    - RailSignalBasePrototype - abstract
      - RailChainSignalPrototype - 'rail-chain-signal'
      - RailSignalPrototype - 'rail-signal'
    - ReactorPrototype - 'reactor'
    - RoboportPrototype - 'roboport'
    - SimpleEntityWithOwnerPrototype - 'simple-entity-with-owner'
      - SimpleEntityWithForcePrototype - 'simple-entity-with-force'
    - SolarPanelPrototype - 'solar-panel'
    - StorageTankPrototype - 'storage-tank'
    - TrainStopPrototype - 'train-stop'
    - TransportBeltConnectablePrototype - abstract
      - LinkedBeltPrototype - 'linked-belt'
      - LoaderPrototype - abstract
        
        Loader1x1Prototype - 'loader-1x1'
        
        Loader1x2Prototype - 'loader'
      - SplitterPrototype - 'splitter'
      - TransportBeltPrototype - 'transport-belt'
      - UndergroundBeltPrototype - 'underground-belt'
    - TurretPrototype - 'turret'
      - AmmoTurretPrototype - 'ammo-turret'
      - ElectricTurretPrototype - 'electric-turret'
      - FluidTurretPrototype - 'fluid-turret'
    - UnitPrototype - 'unit'
    - VehiclePrototype - abstract
      - CarPrototype - 'car'
      - RollingStockPrototype - abstract
        
        ArtilleryWagonPrototype - 'artillery-wagon'
        
        CargoWagonPrototype - 'cargo-wagon'
        
        FluidWagonPrototype - 'fluid-wagon'
        
        LocomotivePrototype - 'locomotive'
      - SpiderVehiclePrototype - 'spider-vehicle'
    - WallPrototype - 'wall'
  - FishPrototype - 'fish'
  - SimpleEntityPrototype - 'simple-entity'
  - SpiderLegPrototype - 'spider-leg'
  - TreePrototype - 'tree'
- ExplosionPrototype - 'explosion'
  - FlameThrowerExplosionPrototype - 'flame-thrower-explosion'
- FireFlamePrototype - 'fire'
- FluidStreamPrototype - 'stream'
- FlyingTextPrototype - 'flying-text'
- HighlightBoxEntityPrototype - 'highlight-box'
- ItemEntityPrototype - 'item-entity'
- ItemRequestProxyPrototype - 'item-request-proxy'
- ParticleSourcePrototype - 'particle-source'
- ProjectilePrototype - 'projectile'
- ResourceEntityPrototype - 'resource'
- RocketSiloRocketPrototype - 'rocket-silo-rocket'
- RocketSiloRocketShadowPrototype - 'rocket-silo-rocket-shadow'
- SmokePrototype - abstract
  - SimpleSmokePrototype - 'smoke'
  - SmokeWithTriggerPrototype - 'smoke-with-trigger'
- SpeechBubblePrototype - 'speech-bubble'
- StickerPrototype - 'sticker'
- TileGhostPrototype - 'tile-ghost'
EquipmentCategory - 'equipment-category'
EquipmentGridPrototype - 'equipment-grid'
EquipmentPrototype - abstract
- ActiveDefenseEquipmentPrototype - 'active-defense-equipment'
- BatteryEquipmentPrototype - 'battery-equipment'
- BeltImmunityEquipmentPrototype - 'belt-immunity-equipment'
- EnergyShieldEquipmentPrototype - 'energy-shield-equipment'
- GeneratorEquipmentPrototype - 'generator-equipment'
- MovementBonusEquipmentPrototype - 'movement-bonus-equipment'
- NightVisionEquipmentPrototype - 'night-vision-equipment'
- RoboportEquipmentPrototype - 'roboport-equipment'
- SolarPanelEquipmentPrototype - 'solar-panel-equipment'
FluidPrototype - 'fluid'
FuelCategory - 'fuel-category'
GuiStyle - 'gui-style'
ItemGroup - 'item-group'
ItemPrototype - 'item'
- AmmoItemPrototype - 'ammo'
- CapsulePrototype - 'capsule'
- GunPrototype - 'gun'
- ItemWithEntityDataPrototype - 'item-with-entity-data'
- ItemWithLabelPrototype - 'item-with-label'
  - ItemWithInventoryPrototype - 'item-with-inventory'
    - BlueprintBookPrototype - 'blueprint-book'
  - ItemWithTagsPrototype - 'item-with-tags'
  - SelectionToolPrototype - 'selection-tool'
    - BlueprintItemPrototype - 'blueprint'
    - CopyPasteToolPrototype - 'copy-paste-tool'
    - DeconstructionItemPrototype - 'deconstruction-item'
    - UpgradeItemPrototype - 'upgrade-item'
- ModulePrototype - 'module'
- RailPlannerPrototype - 'rail-planner'
- SpidertronRemotePrototype - 'spidertron-remote'
- ToolPrototype - 'tool'
  - ArmorPrototype - 'armor'
  - MiningToolPrototype - 'mining-tool'
  - RepairToolPrototype - 'repair-tool'
ItemSubGroup - 'item-subgroup'
ModuleCategory - 'module-category'
NamedNoiseExpression - 'noise-expression'
NoiseLayer - 'noise-layer'
ParticlePrototype - 'optimized-particle'
RecipeCategory - 'recipe-category'
RecipePrototype - 'recipe'
ResourceCategory - 'resource-category'
ShortcutPrototype - 'shortcut'
TechnologyPrototype - 'technology'
TilePrototype - 'tile'
TipsAndTricksItem - 'tips-and-tricks-item'
TrivialSmokePrototype - 'trivial-smoke'
TutorialDefinition - 'tutorial'
UtilityConstants - 'utility-constants'
UtilitySounds - 'utility-sounds'
UtilitySprites - 'utility-sprites'
VirtualSignalPrototype - 'virtual-signal'

Properties

default

sorted

type	:: string	Specifies the kind of prototype this is.
Specifies the kind of prototype this is.
name	:: string	Unique textual identification of the prototype.
Unique textual identification of the prototype.
order optional	:: Order	Used to order prototypes in inventory, recipes and GUIs.
Used to order prototypes in inventory, recipes and GUIs.
localised_name optional	:: LocalisedString	Overwrites the name set in the locale file.
Overwrites the name set in the locale file.
localised_description optional	:: LocalisedString	Overwrites the description set in the locale file.
Overwrites the description set in the locale file.

name	:: string	Unique textual identification of the prototype.
Unique textual identification of the prototype.
type	:: string	Specifies the kind of prototype this is.
Specifies the kind of prototype this is.
localised_description optional	:: LocalisedString	Overwrites the description set in the locale file.
Overwrites the description set in the locale file.
localised_name optional	:: LocalisedString	Overwrites the name set in the locale file.
Overwrites the name set in the locale file.
order optional	:: Order	Used to order prototypes in inventory, recipes and GUIs.
Used to order prototypes in inventory, recipes and GUIs.

Properties

type :: string

Specifies the kind of prototype this is.

For a list of all types used in vanilla, see data.raw.

name :: string

Unique textual identification of the prototype. May not contain a dot, nor exceed a length of 200 characters.

For a list of all names used in vanilla, see data.raw.

order :: Order optional

Default: ""

Used to order prototypes in inventory, recipes and GUIs. May not exceed a length of 200 characters.

localised_name :: LocalisedString optional

Overwrites the name set in the locale file. Can be used to easily set a procedurally-generated name because the LocalisedString format allows to insert parameters into the name directly from the Lua script.

localised_description :: LocalisedString optional

Overwrites the description set in the locale file. The description is usually shown in the tooltip of the prototype.

Factorio Prototype Docs Version 1.1.89

PrototypeBase - abstract

Properties

Properties

type :: string

name :: string

order :: Order optional

localised_name :: LocalisedString optional

localised_description :: LocalisedString optional

Prototypes

Types