Compare commits
3 Commits
cb6e046b81
...
tahrion_te
| Author | SHA1 | Date | |
|---|---|---|---|
| cfa75bd8f3 | |||
| b08f808167 | |||
| eb69779b0d |
@@ -32,8 +32,7 @@
|
||||
"vector",
|
||||
"Ensure",
|
||||
"string",
|
||||
"string_utf8",
|
||||
"Profiler"
|
||||
"string_utf8"
|
||||
],
|
||||
"globalsRegex": []
|
||||
},
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
name: PR-template
|
||||
about: PR-template
|
||||
name: Сообщение об ошибке
|
||||
about: Сообщить о недоработке игры, которую необходимо исправить.
|
||||
labels:
|
||||
- pr/wait review
|
||||
- review/need a maintainer
|
||||
@@ -23,12 +23,12 @@ body:
|
||||
attributes:
|
||||
label: Требования
|
||||
options:
|
||||
- label: Я запускал игру и убедился в том, что она работает.
|
||||
required: true
|
||||
- label: Я ознакомлен с соглашением по разработке и мои изменения следуют принятым стандартам.
|
||||
required: true
|
||||
- label: Я запускал игру и убедился в том, что она работает.
|
||||
required: false
|
||||
- label: Я указал в описании запроса метки (label) с префиксом `Edit:` в соответствии с теми изменениями, которые сделал.
|
||||
required: false
|
||||
required: true
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
|
||||
@@ -1,8 +1,7 @@
|
||||
# Source code licensing
|
||||
Source code licensing:
|
||||
|
||||
**The MIT License (MIT)**
|
||||
|
||||
Copyright (c) 2025-2026 Apancore.Studio, Van (varttist), Doloment
|
||||
The MIT License (MIT)
|
||||
Copyright (c) 2025 Apancore.Studio, Doloment
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
@@ -12,13 +11,9 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
|
||||
|
||||
------------------------
|
||||
|
||||
# Sprites licensing
|
||||
Sprites licensing:
|
||||
|
||||
**CC BY 4.0**
|
||||
|
||||
Copyright (c) 2025-2026 Apancore.Studio, Van (varttist) and others (see list below)
|
||||
|
||||
All textures except those listed here are copyrighted by Van (varttist) and are distributed under the CC BY 4.0.
|
||||
CC BY 4.0
|
||||
Copyright (c) 2025 Apancore.Studio, Doloment and others (see list below)
|
||||
|
||||
List of all textures and authors:
|
||||
- ...
|
||||
218
docs/MapGen_docs.txt
Normal file
218
docs/MapGen_docs.txt
Normal file
@@ -0,0 +1,218 @@
|
||||
MapGen.PastCalcNoiseValue *MapGen.PastCalcNoiseValue*
|
||||
|
||||
Type: ~
|
||||
|
||||
|
||||
|
||||
MapGen *MapGen*
|
||||
|
||||
Fields: ~
|
||||
{layersByName} (table<string,MapGen.Layer>)
|
||||
{layersList} (MapGen.Layer[])
|
||||
{staticsByName} (table<string,MapGen.StaticLayer>)
|
||||
{staticsList} (MapGen.StaticLayer[])
|
||||
{layersNoisesInitialized} (boolean) Is the fractal noise of the layer initialized? This is necessary for a one-time noise initialization.
|
||||
{cavernsNoiseInitialized} (boolean) Is the fractal noise of the caverns initialized? This is necessary for a one-time noise initialization.
|
||||
{isRunning} (boolean) A static field that guarantees that only one instance of the `MapGen` class will work.
|
||||
{nodeIDs} (table<string,number>)
|
||||
|
||||
|
||||
MapGenDef *MapGenDef*
|
||||
Definition table for the `MapGen`.
|
||||
|
||||
**Only for EmmyLua.**
|
||||
|
||||
Fields: ~
|
||||
{nodes} (table<string,string>)
|
||||
|
||||
|
||||
MapGen:new({def}) *MapGen:new*
|
||||
|
||||
Parameters: ~
|
||||
{def} (MapGenDef)
|
||||
|
||||
Returns: ~
|
||||
(MapGen)
|
||||
|
||||
|
||||
MapGen:getLayerByHeight({yPos}) *MapGen:getLayerByHeight*
|
||||
Determines which layer a node belongs to based on its height coordinate.
|
||||
|
||||
Parameters: ~
|
||||
{yPos} (number) @return MapGen.Layer?
|
||||
|
||||
|
||||
MapGen:getStaticByHeight({yPos}) *MapGen:getStaticByHeight*
|
||||
Determines which statics layer a node belongs to based on its height coordinate.
|
||||
|
||||
Parameters: ~
|
||||
{yPos} (number) @return MapGen.StaticLayer?
|
||||
|
||||
|
||||
MapGen:registerLayer({name}, {def}) *MapGen:registerLayer*
|
||||
Mark the world area between two heights as a `MapGen.Layer`.
|
||||
|
||||
Note: layers must not overlap.
|
||||
|
||||
Parameters: ~
|
||||
{name} (string) The name that will be assigned to the layer. The name must be unique for each layer.
|
||||
{def} (MapGen.LayerDef) Layer description table, see details `MapGen.LayerDef`.
|
||||
|
||||
|
||||
*MapGen:registerLayerNoiseColor*
|
||||
MapGen:registerLayerNoiseColor({layerName}, {category}, {color}, {noiseParams})
|
||||
Register the color and the noise parameters that correspond to it.
|
||||
|
||||
Parameters: ~
|
||||
{layerName} (string) The name of the layer for which the color will be registered.
|
||||
{category} (MapGen.Layer.Category) Category indicating what will be generated by noise.
|
||||
{color} (ColorString) Noise color. Must be unique.
|
||||
{noiseParams} (NoiseParams) Fractal noise parameters.
|
||||
|
||||
|
||||
*MapGen:registerStaticLayer*
|
||||
MapGen:registerStaticLayer({name}, {def})
|
||||
Mark the world area between two heights as a `MapGen.StaticLayer`.
|
||||
|
||||
Note: layers must not overlap.
|
||||
|
||||
Parameters: ~
|
||||
{name} (string) The name that will be assigned to the static layer. The name must be unique for each layer.
|
||||
{def} (MapGen.StaticLayerDef) Static layer description table, see details `MapGen.StaticLayerDef`.
|
||||
|
||||
|
||||
*MapGen:registerPeak*
|
||||
MapGen:registerPeak({layerName}, {category}, {def})
|
||||
Mark a world point as `MapGen.Peak` and assign it a specific color that will affect the generation.
|
||||
|
||||
Note: The peaks shouldn't overlap. This won't cause any errors, but it might ruin the generation.
|
||||
|
||||
Parameters: ~
|
||||
{layerName} (string) The name of the layer in which the new peak will be included.
|
||||
{category} (MapGen.Layer.Category) Category indicating what will be generated by peak.
|
||||
{def} (MapGen.PeakDef) Peak description table, see details `MapGen.PeakDef`.
|
||||
|
||||
|
||||
*MapGen:register2DPeak*
|
||||
MapGen:register2DPeak({layerName}, {category}, {def})
|
||||
Mark a world point as `MapGen.Peak` and assign it a specific color that will affect the generation.
|
||||
The Y coordinate will be forced to zero, and the `is2d` group will be added to the groups field.
|
||||
|
||||
Note: The peaks shouldn't overlap. This won't cause any errors, but it might ruin the generation.
|
||||
|
||||
Parameters: ~
|
||||
{layerName} (string) The name of the layer in which the new peak will be included.
|
||||
{category} (MapGen.Layer.Category) Category indicating what will be generated by peak.
|
||||
{def} (MapGen.PeakDef) Peak description table, see details `MapGen.PeakDef`.
|
||||
|
||||
|
||||
*MapGen:register2DPeaks*
|
||||
MapGen:register2DPeaks({layerName}, {category}, {defs})
|
||||
Mark the world points as `MapGen.Peak` and assign them all a specific noise that will affect generation.
|
||||
The Y coordinate will be forced to zero, and the `is2d` group will be added to the groups field.
|
||||
|
||||
Note: The peaks shouldn't overlap. This won't cause any errors, but it might ruin the generation.
|
||||
|
||||
Parameters: ~
|
||||
{layerName} (string) The name of the layer in which the new peaks will be included.
|
||||
{category} (MapGen.Layer.Category) Category indicating what will be generated by peaks.
|
||||
{defs} (MapGen.PeakDef[]) Peaks description table, see details `MapGen.PeakDef`.
|
||||
|
||||
|
||||
*MapGen:register2DPeaksFromFile*
|
||||
MapGen:register2DPeaksFromFile({layerName}, {map}, {scale}, {zeroPos}, {category}, {groups?})
|
||||
Extract the `MapGen.Peak` from the image and assign them all a specific color that will affect the generation.
|
||||
|
||||
Parameters: ~
|
||||
{layerName} (string) The name of the layer in which the new peaks will be included.
|
||||
{map} (string) The name of the image from which the peaks will be extracted. It should be located in the `<mod_name>/textures/maps` folder and have the following format `<image_name>.ff`
|
||||
{scale} (number) Multiplier of how many blocks (nodes) will be between image pixels. It is not recommended to set the value below 50 for performance reasons.
|
||||
{zeroPos} (Position2d) The position in pixels where the zero world coordinate will be in the image.
|
||||
{category} (MapGen.Layer.Category) Category indicating what will be generated by peaks.
|
||||
{groups?} (table<string,number>) Groups that will be added to all peaks.
|
||||
|
||||
|
||||
*MapGen:registerBiome*
|
||||
MapGen:registerBiome({layerName}, {biomeName}, {def})
|
||||
Mark a point on the biomes diagram and constrain the world area by height to mark it as `MapGen.Biome`.
|
||||
|
||||
Parameters: ~
|
||||
{layerName} (string) The name of the layer in which the new biome will be included.
|
||||
{biomeName} (string) The name to be assigned to the biome. The name must be unique for each biome.
|
||||
{def} (MapGen.BiomeDef) Biome description table, see details `MapGen.BiomeDef`
|
||||
|
||||
|
||||
*MapGen:registerCavern*
|
||||
MapGen:registerCavern({layerName}, {cavernName}, {def})
|
||||
Mark the world area between two heights as a `MapGen.Cavern` and assign the noise that the cave will be generated from.
|
||||
|
||||
Parameters: ~
|
||||
{layerName} (string) The name of the layer in which the new cavern will be included.
|
||||
{cavernName} (string) The name to be assigned to the cavern. The name must be unique for each cavern.
|
||||
{def} (MapGen.CavernDef) Cavern description table, see details `MapGen.CavernDef`
|
||||
|
||||
|
||||
MapGen:initLayersTriangultaion() *MapGen:initLayersTriangultaion*
|
||||
Divide all layers into triangles whose vertices are the `Mapgen.Peak` belonging to these layers.
|
||||
|
||||
|
||||
MapGen:initLayersNoises() *MapGen:initLayersNoises*
|
||||
Initialize all layer noises. This should be called after the map object is loaded.
|
||||
|
||||
|
||||
MapGen:initBiomesDiagram() *MapGen:initBiomesDiagram*
|
||||
Initialization of the biome diagram using the Voronoi method.
|
||||
|
||||
|
||||
MapGen:initCavernsNoise() *MapGen:initCavernsNoise*
|
||||
Initialize caverns's noises. This should be called after the map object is loaded.
|
||||
|
||||
|
||||
*MapGen:getNoises2dValue*
|
||||
MapGen:getNoises2dValue({category}, {layer}, {x}, {y}, {z})
|
||||
Calculates a smoothed 2D noise value based on a preliminary space partitioning.
|
||||
|
||||
Returns `nil` if the point is not included in any triangle.
|
||||
|
||||
Parameters: ~
|
||||
{category} (MapGen.Layer.Category)
|
||||
{layer} (MapGen.Layer)
|
||||
{x} (integer)
|
||||
{y} (integer)
|
||||
{z} (integer) @return number?
|
||||
|
||||
|
||||
*MapGen:getNoises3dValues*
|
||||
MapGen:getNoises3dValues({layer}, {x}, {y}, {z})
|
||||
Calculates a smoothed 3D noise value based on a preliminary space partitioning.
|
||||
|
||||
Returns `nil` if the point is not included in any tetrahedron.
|
||||
|
||||
|
||||
Parameters: ~
|
||||
{layer} (MapGen.Layer)
|
||||
{x} (number)
|
||||
{y} (number)
|
||||
{z} (number) @return number?
|
||||
|
||||
|
||||
*MapGen:onMapGenerated*
|
||||
MapGen:onMapGenerated({voxelManip}, {minPos}, {maxPos}, {blockseed})
|
||||
Chunk generation handler.
|
||||
|
||||
Parameters: ~
|
||||
{voxelManip} (VoxelManip)
|
||||
{minPos} (Position)
|
||||
{maxPos} (Position)
|
||||
{blockseed} (number)
|
||||
|
||||
|
||||
MapGen:run() *MapGen:run*
|
||||
Run world generation through this mapgen object
|
||||
|
||||
Note: only one instance of a `MapGen` class can be running.
|
||||
|
||||
**FOR MAPGEN ENVIRONMENT ONLY**
|
||||
|
||||
|
||||
vim:tw=78:ts=8:noet:ft=help:norl:
|
||||
54
docs/docs/index.md
Normal file
54
docs/docs/index.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# index
|
||||
|
||||
|
||||
## Types
|
||||
|
||||
- [alias Category](types/MapGen.Layer.Category.md)
|
||||
- [alias CircumCircleEnum](types/MapGen.Triangle.CircumCircleEnum.md)
|
||||
- [alias ColoredDotsTable](types/ColoredDotsTable.md)
|
||||
- [alias Neighbours](types/MapGen.Triangle.Neighbours.md)
|
||||
- [alias PastCalcNoiseValue](types/MapGen.PastCalcNoiseValue.md)
|
||||
- [alias generateFunc](types/generateFunc.md)
|
||||
- [class Biome](types/MapGen.Biome.md)
|
||||
- [class BiomeDef](types/MapGen.BiomeDef.md)
|
||||
- [class Cavern](types/MapGen.Cavern.md)
|
||||
- [class CavernDef](types/MapGen.CavernDef.md)
|
||||
- [class Decoration](types/MapGen.Decoration.md)
|
||||
- [class Edge](types/MapGen.Triangulation.Edge.md)
|
||||
- [class FakePeak](types/MapGen.Triangulation.FakePeak.md)
|
||||
- [class GroundNodes](types/MapGen.Biome.GroundNodes.md)
|
||||
- [class GroundNodesIDs](types/MapGen.Biome.GroundNodesIDs.md)
|
||||
- [class Layer](types/MapGen.Layer.md)
|
||||
- [class LayerDef](types/MapGen.LayerDef.md)
|
||||
- [class MapGen](types/MapGen.md)
|
||||
- [class MapGenDef](types/MapGenDef.md)
|
||||
- [class Peak](types/MapGen.Peak.md)
|
||||
- [class PeakDef](types/MapGen.PeakDef.md)
|
||||
- [class StaticLayer](types/MapGen.StaticLayer.md)
|
||||
- [class StaticLayerDef](types/MapGen.StaticLayerDef.md)
|
||||
- [class Tetrahedron](types/MapGen.Tetrahedron.md)
|
||||
- [class Triangle](types/MapGen.Triangle.md)
|
||||
- [class Triangulation](types/MapGen.Triangulation.md)
|
||||
|
||||
|
||||
|
||||
## Modules
|
||||
- [MapGen](modules/MapGen.md)
|
||||
- [MapGen.Biome](modules/MapGen.Biome.md)
|
||||
- [MapGen.Biome.GroundNodes](modules/MapGen.Biome.GroundNodes.md)
|
||||
- [MapGen.Biome.GroundNodesIds](modules/MapGen.Biome.GroundNodesIds.md)
|
||||
- [MapGen.Cavern](modules/MapGen.Cavern.md)
|
||||
- [MapGen.Decoration](modules/MapGen.Decoration.md)
|
||||
- [MapGen.Layer](modules/MapGen.Layer.md)
|
||||
- [MapGen.Peak](modules/MapGen.Peak.md)
|
||||
- [MapGen.StaticLayer](modules/MapGen.StaticLayer.md)
|
||||
- [MapGen.Tetrahedron](modules/MapGen.Tetrahedron.md)
|
||||
- [MapGen.Triangle](modules/MapGen.Triangle.md)
|
||||
- [MapGen.Triangulation](modules/MapGen.Triangulation.md)
|
||||
- [MapGen.Triangulation.Edge](modules/MapGen.Triangulation.Edge.md)
|
||||
- [MapGen.Triangulation.FakePeak](modules/MapGen.Triangulation.FakePeak.md)
|
||||
- [MapGen.ff2luat](modules/MapGen.ff2luat.md)
|
||||
|
||||
|
||||
|
||||
|
||||
85
docs/docs/modules/MapGen.Biome.GroundNodes.md
Normal file
85
docs/docs/modules/MapGen.Biome.GroundNodes.md
Normal file
@@ -0,0 +1,85 @@
|
||||
# global MapGen.Biome.GroundNodes
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### GroundNodes.turf
|
||||
---
|
||||
```lua
|
||||
GroundNodes.turf : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
The soil covering the surface of the biome
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### GroundNodes.soil
|
||||
---
|
||||
```lua
|
||||
GroundNodes.soil : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
The soil beneath the turf. The height of this layer depends on `Biome.soilHeight`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### GroundNodes.rock
|
||||
---
|
||||
```lua
|
||||
GroundNodes.rock : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
The rock found beneath the soil of a biome.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### GroundNodes.bottom
|
||||
---
|
||||
```lua
|
||||
GroundNodes.bottom : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
Covering the bottom of reservoirs.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
85
docs/docs/modules/MapGen.Biome.GroundNodesIds.md
Normal file
85
docs/docs/modules/MapGen.Biome.GroundNodesIds.md
Normal file
@@ -0,0 +1,85 @@
|
||||
# global MapGen.Biome.GroundNodesIds
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### GroundNodesIDs.turf
|
||||
---
|
||||
```lua
|
||||
GroundNodesIDs.turf : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
The soil covering the surface of the biome
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### GroundNodesIDs.soil
|
||||
---
|
||||
```lua
|
||||
GroundNodesIDs.soil : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
The soil beneath the turf. The height of this layer depends on `Biome.soilHeight`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### GroundNodesIDs.rock
|
||||
---
|
||||
```lua
|
||||
GroundNodesIDs.rock : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
The rock found beneath the soil of a biome.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### GroundNodesIDs.bottom
|
||||
---
|
||||
```lua
|
||||
GroundNodesIDs.bottom : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
Covering the bottom of reservoirs.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
307
docs/docs/modules/MapGen.Biome.md
Normal file
307
docs/docs/modules/MapGen.Biome.md
Normal file
@@ -0,0 +1,307 @@
|
||||
# global MapGen.Biome
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Biome.new
|
||||
---
|
||||
```lua
|
||||
function Biome.new(
|
||||
name: string,
|
||||
def: MapGen.BiomeDef {
|
||||
tempPoint = number,
|
||||
humidityPoint = number,
|
||||
minY = number,
|
||||
maxY = number,
|
||||
groundNodes = MapGen.Biome.GroundNodes,
|
||||
soilHeight = number,
|
||||
generateAir = generateFunc?,
|
||||
generateCavernAir = generateFunc?,
|
||||
generateWater = generateFunc?,
|
||||
generateRock = generateFunc?,
|
||||
generateTurf = generateFunc?,
|
||||
generateSoil = generateFunc?,
|
||||
generateBottom = generateFunc?,
|
||||
}
|
||||
) -> MapGen.Biome {
|
||||
name = string,
|
||||
tempPoint = number,
|
||||
humidityPoint = number,
|
||||
minY = number,
|
||||
maxY = number,
|
||||
groundNodes = MapGen.Biome.GroundNodes,
|
||||
groundNodesIDs = MapGen.Biome.GroundNodesIDs,
|
||||
soilHeight = number,
|
||||
generateAir = generateFunc,
|
||||
generateCavernAir = generateFunc,
|
||||
generateWater = generateFunc,
|
||||
generateRock = generateFunc,
|
||||
generateTurf = generateFunc,
|
||||
generateSoil = generateFunc,
|
||||
generateBottom = generateFunc,
|
||||
new = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### Biome.name
|
||||
---
|
||||
```lua
|
||||
Biome.name : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.tempPoint
|
||||
---
|
||||
```lua
|
||||
Biome.tempPoint : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.humidityPoint
|
||||
---
|
||||
```lua
|
||||
Biome.humidityPoint : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.minY
|
||||
---
|
||||
```lua
|
||||
Biome.minY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.maxY
|
||||
---
|
||||
```lua
|
||||
Biome.maxY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.groundNodes
|
||||
---
|
||||
```lua
|
||||
Biome.groundNodes : MapGen.Biome.GroundNodes {
|
||||
turf: string,
|
||||
soil: string,
|
||||
rock: string,
|
||||
bottom: string,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.groundNodesIDs
|
||||
---
|
||||
```lua
|
||||
Biome.groundNodesIDs : MapGen.Biome.GroundNodesIDs {
|
||||
turf: number,
|
||||
soil: number,
|
||||
rock: number,
|
||||
bottom: number,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.soilHeight
|
||||
---
|
||||
```lua
|
||||
Biome.soilHeight : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.generateAir
|
||||
---
|
||||
```lua
|
||||
Biome.generateAir : generateFunc
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.generateCavernAir
|
||||
---
|
||||
```lua
|
||||
Biome.generateCavernAir : generateFunc
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.generateWater
|
||||
---
|
||||
```lua
|
||||
Biome.generateWater : generateFunc
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.generateRock
|
||||
---
|
||||
```lua
|
||||
Biome.generateRock : generateFunc
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.generateTurf
|
||||
---
|
||||
```lua
|
||||
Biome.generateTurf : generateFunc
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.generateSoil
|
||||
---
|
||||
```lua
|
||||
Biome.generateSoil : generateFunc
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.generateBottom
|
||||
---
|
||||
```lua
|
||||
Biome.generateBottom : generateFunc
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
203
docs/docs/modules/MapGen.Cavern.md
Normal file
203
docs/docs/modules/MapGen.Cavern.md
Normal file
@@ -0,0 +1,203 @@
|
||||
# global MapGen.Cavern
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Cavern.getNoise
|
||||
---
|
||||
```lua
|
||||
function Cavern.getNoise()-> ValueNoise
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Cavern.initNoise
|
||||
---
|
||||
```lua
|
||||
function Cavern.initNoise()-> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Cavern.getGroups
|
||||
---
|
||||
```lua
|
||||
function Cavern.getGroups()
|
||||
-> table<string,number>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Cavern.new
|
||||
---
|
||||
```lua
|
||||
function Cavern.new(
|
||||
name: string,
|
||||
def: MapGen.CavernDef {
|
||||
minY = number,
|
||||
maxY = number,
|
||||
noiseParams = NoiseParams,
|
||||
smoothDistance = number,
|
||||
threshold = number?,
|
||||
groups = table<string,number>?,
|
||||
}
|
||||
) -> MapGen.Cavern {
|
||||
name = string,
|
||||
minY = number,
|
||||
maxY = number,
|
||||
smoothDistance = number,
|
||||
threshold = number,
|
||||
getNoise = function,
|
||||
initNoise = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
isCavern = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Cavern.isCavern
|
||||
---
|
||||
```lua
|
||||
function Cavern.isCavern(
|
||||
x: integer,
|
||||
y: integer,
|
||||
z: integer
|
||||
) -> boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns `true` if there is a cavern at the specified coordinates.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### Cavern.name
|
||||
---
|
||||
```lua
|
||||
Cavern.name : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Cavern.minY
|
||||
---
|
||||
```lua
|
||||
Cavern.minY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Cavern.maxY
|
||||
---
|
||||
```lua
|
||||
Cavern.maxY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Cavern.smoothDistance
|
||||
---
|
||||
```lua
|
||||
Cavern.smoothDistance : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Cavern.threshold
|
||||
---
|
||||
```lua
|
||||
Cavern.threshold : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
36
docs/docs/modules/MapGen.Decoration.md
Normal file
36
docs/docs/modules/MapGen.Decoration.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# global MapGen.Decoration
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Decoration.new
|
||||
---
|
||||
```lua
|
||||
function Decoration.new() -> MapGen.Decoration {
|
||||
new = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
673
docs/docs/modules/MapGen.Layer.md
Normal file
673
docs/docs/modules/MapGen.Layer.md
Normal file
@@ -0,0 +1,673 @@
|
||||
# global MapGen.Layer
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Layer.calcTemp
|
||||
---
|
||||
```lua
|
||||
function Layer.calcTemp(
|
||||
self: MapGen.Layer {
|
||||
name = string,
|
||||
minY = integer,
|
||||
maxY = integer,
|
||||
minTemp = integer,
|
||||
maxTemp = integer,
|
||||
minHumidity = integer,
|
||||
maxHumidity = integer,
|
||||
waterLevel = integer,
|
||||
peaksList = { humidity: MapGen.Peak[], landscape: MapGen.Peak[], temp: MapGen.Peak[] },
|
||||
noisesByColor = { humidity: table<ColorString,ValueNoise>, landscape: table<ColorString,ValueNoise>, temp: table<ColorString,ValueNoise> },
|
||||
noisesParamsByColor = { humidity: table<ColorString,NoiseParams>, landscape: table<ColorString,NoiseParams>, temp: table<ColorString,NoiseParams> },
|
||||
biomesByName = table<string,MapGen.Biome>,
|
||||
biomesList = MapGen.Biome[],
|
||||
biomesDiagram = table,
|
||||
biomesGorizontalScattering = integer,
|
||||
biomesVerticalScattering = integer,
|
||||
cavernsByName = table<string,MapGen.Cavern>,
|
||||
cavernsList = MapGen.Cavern[],
|
||||
trianglesList = { humidity: MapGen.Triangle[], landscape: MapGen.Triangle[], temp: MapGen.Triangle[] },
|
||||
tetrahedronsList = MapGen.Tetrahedron[],
|
||||
calcTemp = function,
|
||||
calcHumidity = function,
|
||||
new = function,
|
||||
addPeak = function,
|
||||
addNoiseParamsColor = function,
|
||||
getNoiseByColor = function,
|
||||
addBiome = function,
|
||||
addCavern = function,
|
||||
initNoises = function,
|
||||
initBiomesDiagram = function,
|
||||
},
|
||||
value: number,
|
||||
height: number
|
||||
)-> number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.calcHumidity
|
||||
---
|
||||
```lua
|
||||
function Layer.calcHumidity(
|
||||
self: MapGen.Layer {
|
||||
name = string,
|
||||
minY = integer,
|
||||
maxY = integer,
|
||||
minTemp = integer,
|
||||
maxTemp = integer,
|
||||
minHumidity = integer,
|
||||
maxHumidity = integer,
|
||||
waterLevel = integer,
|
||||
peaksList = { humidity: MapGen.Peak[], landscape: MapGen.Peak[], temp: MapGen.Peak[] },
|
||||
noisesByColor = { humidity: table<ColorString,ValueNoise>, landscape: table<ColorString,ValueNoise>, temp: table<ColorString,ValueNoise> },
|
||||
noisesParamsByColor = { humidity: table<ColorString,NoiseParams>, landscape: table<ColorString,NoiseParams>, temp: table<ColorString,NoiseParams> },
|
||||
biomesByName = table<string,MapGen.Biome>,
|
||||
biomesList = MapGen.Biome[],
|
||||
biomesDiagram = table,
|
||||
biomesGorizontalScattering = integer,
|
||||
biomesVerticalScattering = integer,
|
||||
cavernsByName = table<string,MapGen.Cavern>,
|
||||
cavernsList = MapGen.Cavern[],
|
||||
trianglesList = { humidity: MapGen.Triangle[], landscape: MapGen.Triangle[], temp: MapGen.Triangle[] },
|
||||
tetrahedronsList = MapGen.Tetrahedron[],
|
||||
calcTemp = function,
|
||||
calcHumidity = function,
|
||||
new = function,
|
||||
addPeak = function,
|
||||
addNoiseParamsColor = function,
|
||||
getNoiseByColor = function,
|
||||
addBiome = function,
|
||||
addCavern = function,
|
||||
initNoises = function,
|
||||
initBiomesDiagram = function,
|
||||
},
|
||||
value: number,
|
||||
height: number
|
||||
)-> number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.new
|
||||
---
|
||||
```lua
|
||||
function Layer.new(
|
||||
name: string,
|
||||
def: MapGen.LayerDef {
|
||||
minY = number,
|
||||
maxY = number,
|
||||
minTemp = number,
|
||||
maxTemp = number,
|
||||
minHumidity = number,
|
||||
maxHumidity = number,
|
||||
waterLevel = number?,
|
||||
calcTemp = (fun(self: MapGen.Layer, value: number, height: number) -> number)?,
|
||||
calcHumidity = (fun(self: MapGen.Layer, value: number, height: number) -> number)?,
|
||||
biomesGorizontalScattering = number?,
|
||||
biomesVerticalScattering = number?,
|
||||
}
|
||||
) -> MapGen.Layer {
|
||||
name = string,
|
||||
minY = integer,
|
||||
maxY = integer,
|
||||
minTemp = integer,
|
||||
maxTemp = integer,
|
||||
minHumidity = integer,
|
||||
maxHumidity = integer,
|
||||
waterLevel = integer,
|
||||
peaksList = { humidity: MapGen.Peak[], landscape: MapGen.Peak[], temp: MapGen.Peak[] },
|
||||
noisesByColor = { humidity: table<ColorString,ValueNoise>, landscape: table<ColorString,ValueNoise>, temp: table<ColorString,ValueNoise> },
|
||||
noisesParamsByColor = { humidity: table<ColorString,NoiseParams>, landscape: table<ColorString,NoiseParams>, temp: table<ColorString,NoiseParams> },
|
||||
biomesByName = table<string,MapGen.Biome>,
|
||||
biomesList = MapGen.Biome[],
|
||||
biomesDiagram = table,
|
||||
biomesGorizontalScattering = integer,
|
||||
biomesVerticalScattering = integer,
|
||||
cavernsByName = table<string,MapGen.Cavern>,
|
||||
cavernsList = MapGen.Cavern[],
|
||||
trianglesList = { humidity: MapGen.Triangle[], landscape: MapGen.Triangle[], temp: MapGen.Triangle[] },
|
||||
tetrahedronsList = MapGen.Tetrahedron[],
|
||||
calcTemp = function,
|
||||
calcHumidity = function,
|
||||
new = function,
|
||||
addPeak = function,
|
||||
addNoiseParamsColor = function,
|
||||
getNoiseByColor = function,
|
||||
addBiome = function,
|
||||
addCavern = function,
|
||||
initNoises = function,
|
||||
initBiomesDiagram = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.addPeak
|
||||
---
|
||||
```lua
|
||||
function Layer.addPeak(
|
||||
category: MapGen.Layer.Category,
|
||||
peak: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Adds a peak to the `Layer.peaksList`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.addNoiseParamsColor
|
||||
---
|
||||
```lua
|
||||
function Layer.addNoiseParamsColor(
|
||||
category: MapGen.Layer.Category,
|
||||
color: ColorString,
|
||||
noiseParams: NoiseParams
|
||||
) -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Adds a NoiseParams color to the `Layer.noisesParamsByColor`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.getNoiseByColor
|
||||
---
|
||||
```lua
|
||||
function Layer.getNoiseByColor(
|
||||
category: MapGen.Layer.Category,
|
||||
color: ColorString
|
||||
) -> ValueNoise
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns noise corresponding to a color.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.addBiome
|
||||
---
|
||||
```lua
|
||||
function Layer.addBiome(
|
||||
biomeName: string,
|
||||
biome: MapGen.Biome {
|
||||
name = string,
|
||||
tempPoint = number,
|
||||
humidityPoint = number,
|
||||
minY = number,
|
||||
maxY = number,
|
||||
groundNodes = MapGen.Biome.GroundNodes,
|
||||
groundNodesIDs = MapGen.Biome.GroundNodesIDs,
|
||||
soilHeight = number,
|
||||
generateAir = generateFunc,
|
||||
generateCavernAir = generateFunc,
|
||||
generateWater = generateFunc,
|
||||
generateRock = generateFunc,
|
||||
generateTurf = generateFunc,
|
||||
generateSoil = generateFunc,
|
||||
generateBottom = generateFunc,
|
||||
new = function,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Adds a biome to the `Layer.biomesByName` & `Layer.biomesList`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.addCavern
|
||||
---
|
||||
```lua
|
||||
function Layer.addCavern(
|
||||
cavernName: string,
|
||||
cavern: MapGen.Cavern {
|
||||
name = string,
|
||||
minY = number,
|
||||
maxY = number,
|
||||
smoothDistance = number,
|
||||
threshold = number,
|
||||
getNoise = function,
|
||||
initNoise = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
isCavern = function,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Adds a cavern to the `Layer.cavernsByName` & `Layer.cavernsList`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.initNoises
|
||||
---
|
||||
```lua
|
||||
function Layer.initNoises() -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Initializes noise for generation.
|
||||
|
||||
Should only be called after the mapgen object has been loaded.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.initBiomesDiagram
|
||||
---
|
||||
```lua
|
||||
function Layer.initBiomesDiagram() -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Initialization of the biome diagram using the Voronoi method.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### Layer.name
|
||||
---
|
||||
```lua
|
||||
Layer.name : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.minY
|
||||
---
|
||||
```lua
|
||||
Layer.minY : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.maxY
|
||||
---
|
||||
```lua
|
||||
Layer.maxY : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.minTemp
|
||||
---
|
||||
```lua
|
||||
Layer.minTemp : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.maxTemp
|
||||
---
|
||||
```lua
|
||||
Layer.maxTemp : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.minHumidity
|
||||
---
|
||||
```lua
|
||||
Layer.minHumidity : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.maxHumidity
|
||||
---
|
||||
```lua
|
||||
Layer.maxHumidity : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.waterLevel
|
||||
---
|
||||
```lua
|
||||
Layer.waterLevel : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.peaksList
|
||||
---
|
||||
```lua
|
||||
Layer.peaksList : { humidity: MapGen.Peak[], landscape: MapGen.Peak[], temp: MapGen.Peak[] }
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.noisesByColor
|
||||
---
|
||||
```lua
|
||||
Layer.noisesByColor : { humidity: table<ColorString,ValueNoise>, landscape: table<ColorString,ValueNoise>, temp: table<ColorString,ValueNoise> }
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.noisesParamsByColor
|
||||
---
|
||||
```lua
|
||||
Layer.noisesParamsByColor : { humidity: table<ColorString,NoiseParams>, landscape: table<ColorString,NoiseParams>, temp: table<ColorString,NoiseParams> }
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.biomesByName
|
||||
---
|
||||
```lua
|
||||
Layer.biomesByName : table<string,MapGen.Biome>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.biomesList
|
||||
---
|
||||
```lua
|
||||
Layer.biomesList : MapGen.Biome[]
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.biomesDiagram
|
||||
---
|
||||
```lua
|
||||
Layer.biomesDiagram : table
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.biomesGorizontalScattering
|
||||
---
|
||||
```lua
|
||||
Layer.biomesGorizontalScattering : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.biomesVerticalScattering
|
||||
---
|
||||
```lua
|
||||
Layer.biomesVerticalScattering : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.cavernsByName
|
||||
---
|
||||
```lua
|
||||
Layer.cavernsByName : table<string,MapGen.Cavern>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.cavernsList
|
||||
---
|
||||
```lua
|
||||
Layer.cavernsList : MapGen.Cavern[]
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.trianglesList
|
||||
---
|
||||
```lua
|
||||
Layer.trianglesList : { humidity: MapGen.Triangle[], landscape: MapGen.Triangle[], temp: MapGen.Triangle[] }
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.tetrahedronsList
|
||||
---
|
||||
```lua
|
||||
Layer.tetrahedronsList : MapGen.Tetrahedron[]
|
||||
```
|
||||
|
||||
|
||||
|
||||
**Not supported**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
157
docs/docs/modules/MapGen.Peak.md
Normal file
157
docs/docs/modules/MapGen.Peak.md
Normal file
@@ -0,0 +1,157 @@
|
||||
# global MapGen.Peak
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Peak.getPeakPos
|
||||
---
|
||||
```lua
|
||||
function Peak.getPeakPos(self)-> vector
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Peak.getColor
|
||||
---
|
||||
```lua
|
||||
function Peak.getColor(self)-> ColorString
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Peak.getGroups
|
||||
---
|
||||
```lua
|
||||
function Peak.getGroups(self)
|
||||
-> table<string,number>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Peak.new
|
||||
---
|
||||
```lua
|
||||
function Peak.new(def: MapGen.PeakDef {
|
||||
pos = vector,
|
||||
color = ColorString,
|
||||
groups = table<string,number>?,
|
||||
}) -> MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Peak.toString
|
||||
---
|
||||
```lua
|
||||
function Peak.toString() -> string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns a string describing the object in a readable form.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Peak.eq
|
||||
---
|
||||
```lua
|
||||
function Peak.eq(other: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}) -> boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns true if the peaks are equivalent.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### Peak.id
|
||||
---
|
||||
```lua
|
||||
Peak.id : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
144
docs/docs/modules/MapGen.StaticLayer.md
Normal file
144
docs/docs/modules/MapGen.StaticLayer.md
Normal file
@@ -0,0 +1,144 @@
|
||||
# global MapGen.StaticLayer
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### StaticLayer.new
|
||||
---
|
||||
```lua
|
||||
function StaticLayer.new(
|
||||
name: string,
|
||||
def: MapGen.StaticLayerDef {
|
||||
minY = number,
|
||||
maxY = number,
|
||||
staticNode = string,
|
||||
generateStaticNode = generateFunc,
|
||||
}
|
||||
) -> MapGen.StaticLayer {
|
||||
name = string,
|
||||
minY = number,
|
||||
maxY = number,
|
||||
staticNode = string,
|
||||
staticNodeID = number,
|
||||
generateStaticNode = generateFunc,
|
||||
new = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### StaticLayer.name
|
||||
---
|
||||
```lua
|
||||
StaticLayer.name : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### StaticLayer.minY
|
||||
---
|
||||
```lua
|
||||
StaticLayer.minY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### StaticLayer.maxY
|
||||
---
|
||||
```lua
|
||||
StaticLayer.maxY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### StaticLayer.staticNode
|
||||
---
|
||||
```lua
|
||||
StaticLayer.staticNode : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### StaticLayer.staticNodeID
|
||||
---
|
||||
```lua
|
||||
StaticLayer.staticNodeID : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### StaticLayer.generateStaticNode
|
||||
---
|
||||
```lua
|
||||
StaticLayer.generateStaticNode : generateFunc
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
536
docs/docs/modules/MapGen.Tetrahedron.md
Normal file
536
docs/docs/modules/MapGen.Tetrahedron.md
Normal file
@@ -0,0 +1,536 @@
|
||||
# global MapGen.Tetrahedron
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Tetrahedron.new
|
||||
---
|
||||
```lua
|
||||
function Tetrahedron.new(
|
||||
p1: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p2: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p3: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p4: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
) -> MapGen.Tetrahedron {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
p3 = MapGen.Peak,
|
||||
p4 = MapGen.Peak,
|
||||
h1 = MapGen.Triangulation.Edge,
|
||||
h2 = MapGen.Triangulation.Edge,
|
||||
h3 = MapGen.Triangulation.Edge,
|
||||
h4 = MapGen.Triangulation.Edge,
|
||||
f1 = MapGen.Triangle,
|
||||
f2 = MapGen.Triangle,
|
||||
f3 = MapGen.Triangle,
|
||||
f4 = MapGen.Triangle,
|
||||
new = function,
|
||||
toString = function,
|
||||
getHeight = function,
|
||||
getCircumSphereCenter = function,
|
||||
getCircumSphereRadius = function,
|
||||
inCircumSphere = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.toString
|
||||
---
|
||||
```lua
|
||||
function Tetrahedron.toString() -> string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns a string describing the object in a readable form.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.getHeight
|
||||
---
|
||||
```lua
|
||||
function Tetrahedron.getHeight(
|
||||
p1: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p2: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p3: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p4: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
) -> MapGen.Triangulation.Edge?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.getCircumSphereCenter
|
||||
---
|
||||
```lua
|
||||
function Tetrahedron.getCircumSphereCenter() -> vector
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the center of the circumscribed sphere.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.getCircumSphereRadius
|
||||
---
|
||||
```lua
|
||||
function Tetrahedron.getCircumSphereRadius() -> number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the radius of the circumscribed sphere.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.inCircumSphere
|
||||
---
|
||||
```lua
|
||||
function Tetrahedron.inCircumSphere(p: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}) -> boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Checks whether a given point lies within the circumscribed sphere of a tetrahedron.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### Tetrahedron.p1
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.p1 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.p2
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.p2 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.p3
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.p3 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.p4
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.p4 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.h1
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.h1 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.h2
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.h2 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.h3
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.h3 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.h4
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.h4 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.f1
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.f1 : MapGen.Triangle {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
p3: MapGen.Peak,
|
||||
e1: MapGen.Triangulation.Edge,
|
||||
e2: MapGen.Triangulation.Edge,
|
||||
e3: MapGen.Triangulation.Edge,
|
||||
h1: MapGen.Triangulation.Edge,
|
||||
h2: MapGen.Triangulation.Edge,
|
||||
h3: MapGen.Triangulation.Edge,
|
||||
neighbours: MapGen.Triangle.Neighbours,
|
||||
color: ColorString?,
|
||||
new: function,
|
||||
...(+13)
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.f2
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.f2 : MapGen.Triangle {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
p3: MapGen.Peak,
|
||||
e1: MapGen.Triangulation.Edge,
|
||||
e2: MapGen.Triangulation.Edge,
|
||||
e3: MapGen.Triangulation.Edge,
|
||||
h1: MapGen.Triangulation.Edge,
|
||||
h2: MapGen.Triangulation.Edge,
|
||||
h3: MapGen.Triangulation.Edge,
|
||||
neighbours: MapGen.Triangle.Neighbours,
|
||||
color: ColorString?,
|
||||
new: function,
|
||||
...(+13)
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.f3
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.f3 : MapGen.Triangle {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
p3: MapGen.Peak,
|
||||
e1: MapGen.Triangulation.Edge,
|
||||
e2: MapGen.Triangulation.Edge,
|
||||
e3: MapGen.Triangulation.Edge,
|
||||
h1: MapGen.Triangulation.Edge,
|
||||
h2: MapGen.Triangulation.Edge,
|
||||
h3: MapGen.Triangulation.Edge,
|
||||
neighbours: MapGen.Triangle.Neighbours,
|
||||
color: ColorString?,
|
||||
new: function,
|
||||
...(+13)
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.f4
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.f4 : MapGen.Triangle {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
p3: MapGen.Peak,
|
||||
e1: MapGen.Triangulation.Edge,
|
||||
e2: MapGen.Triangulation.Edge,
|
||||
e3: MapGen.Triangulation.Edge,
|
||||
h1: MapGen.Triangulation.Edge,
|
||||
h2: MapGen.Triangulation.Edge,
|
||||
h3: MapGen.Triangulation.Edge,
|
||||
neighbours: MapGen.Triangle.Neighbours,
|
||||
color: ColorString?,
|
||||
new: function,
|
||||
...(+13)
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
745
docs/docs/modules/MapGen.Triangle.md
Normal file
745
docs/docs/modules/MapGen.Triangle.md
Normal file
@@ -0,0 +1,745 @@
|
||||
# global MapGen.Triangle
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Triangle.new
|
||||
---
|
||||
```lua
|
||||
function Triangle.new(
|
||||
p1: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p2: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p3: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
) -> MapGen.Triangle {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
p3 = MapGen.Peak,
|
||||
e1 = MapGen.Triangulation.Edge,
|
||||
e2 = MapGen.Triangulation.Edge,
|
||||
e3 = MapGen.Triangulation.Edge,
|
||||
h1 = MapGen.Triangulation.Edge,
|
||||
h2 = MapGen.Triangulation.Edge,
|
||||
h3 = MapGen.Triangulation.Edge,
|
||||
neighbours = MapGen.Triangle.Neighbours,
|
||||
color = ColorString?,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
same = function,
|
||||
getCenter = function,
|
||||
getArea = function,
|
||||
getHeight = function,
|
||||
getHeight2D = function,
|
||||
getSidesLength = function,
|
||||
getSidesLength2D = function,
|
||||
getCircumCenter2D = function,
|
||||
getCircumRadius2D = function,
|
||||
getCircumCircle2D = function,
|
||||
inCircumCircle2D = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.toString
|
||||
---
|
||||
```lua
|
||||
function Triangle.toString() -> string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns a string describing the object in a readable form.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.eq
|
||||
---
|
||||
```lua
|
||||
function Triangle.eq(other: MapGen.Triangle {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
p3 = MapGen.Peak,
|
||||
e1 = MapGen.Triangulation.Edge,
|
||||
e2 = MapGen.Triangulation.Edge,
|
||||
e3 = MapGen.Triangulation.Edge,
|
||||
h1 = MapGen.Triangulation.Edge,
|
||||
h2 = MapGen.Triangulation.Edge,
|
||||
h3 = MapGen.Triangulation.Edge,
|
||||
neighbours = MapGen.Triangle.Neighbours,
|
||||
color = ColorString?,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
same = function,
|
||||
getCenter = function,
|
||||
getArea = function,
|
||||
getHeight = function,
|
||||
getHeight2D = function,
|
||||
getSidesLength = function,
|
||||
getSidesLength2D = function,
|
||||
getCircumCenter2D = function,
|
||||
getCircumRadius2D = function,
|
||||
getCircumCircle2D = function,
|
||||
inCircumCircle2D = function,
|
||||
}) -> boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns true if the triangles are equivalent.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.same
|
||||
---
|
||||
```lua
|
||||
function Triangle.same(other: MapGen.Triangle {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
p3 = MapGen.Peak,
|
||||
e1 = MapGen.Triangulation.Edge,
|
||||
e2 = MapGen.Triangulation.Edge,
|
||||
e3 = MapGen.Triangulation.Edge,
|
||||
h1 = MapGen.Triangulation.Edge,
|
||||
h2 = MapGen.Triangulation.Edge,
|
||||
h3 = MapGen.Triangulation.Edge,
|
||||
neighbours = MapGen.Triangle.Neighbours,
|
||||
color = ColorString?,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
same = function,
|
||||
getCenter = function,
|
||||
getArea = function,
|
||||
getHeight = function,
|
||||
getHeight2D = function,
|
||||
getSidesLength = function,
|
||||
getSidesLength2D = function,
|
||||
getCircumCenter2D = function,
|
||||
getCircumRadius2D = function,
|
||||
getCircumCircle2D = function,
|
||||
inCircumCircle2D = function,
|
||||
}) -> boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns true if the triangles are similar.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getCenter
|
||||
---
|
||||
```lua
|
||||
function Triangle.getCenter() -> vector
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the coordinates of the triangle's center.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getArea
|
||||
---
|
||||
```lua
|
||||
function Triangle.getArea() -> number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the area of a triangle.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getHeight
|
||||
---
|
||||
```lua
|
||||
function Triangle.getHeight(
|
||||
p1: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p2: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p3: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
) -> MapGen.Triangulation.Edge {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
same = function,
|
||||
length = function,
|
||||
getMidPoint = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the perpendicular from the vertex Peak1 to the line Peak2-Peak3.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getHeight2D
|
||||
---
|
||||
```lua
|
||||
function Triangle.getHeight2D(
|
||||
p1: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p2: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p3: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
) -> MapGen.Triangulation.Edge {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
same = function,
|
||||
length = function,
|
||||
getMidPoint = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the perpendicular from the vertex Peak1 to the line Peak2-Peak3.
|
||||
|
||||
Note: This function does not take into account the Y-coordinate,
|
||||
that is, the calculation is performed on the projection of the triangle XZ.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getSidesLength
|
||||
---
|
||||
```lua
|
||||
function Triangle.getSidesLength()
|
||||
-> number
|
||||
-> number
|
||||
-> number
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the length of the edges
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getSidesLength2D
|
||||
---
|
||||
```lua
|
||||
function Triangle.getSidesLength2D()
|
||||
-> number
|
||||
-> number
|
||||
-> number
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the length of the edges.
|
||||
|
||||
Note: This function does not take into account the Y-coordinate,
|
||||
that is, the calculation is performed on the projection of the triangle XZ.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getCircumCenter2D
|
||||
---
|
||||
```lua
|
||||
function Triangle.getCircumCenter2D() -> vector
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the coordinates of the circumcircle center.
|
||||
|
||||
Note: This function does not take into account the Y-coordinate,
|
||||
that is, the calculation is performed on the projection of the triangle XZ.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getCircumRadius2D
|
||||
---
|
||||
```lua
|
||||
function Triangle.getCircumRadius2D() -> number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the radius of the circumcircle.
|
||||
|
||||
Note: This function does not take into account the Y-coordinate,
|
||||
that is, the calculation is performed on the projection of the triangle XZ.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getCircumCircle2D
|
||||
---
|
||||
```lua
|
||||
function Triangle.getCircumCircle2D()
|
||||
-> vector
|
||||
-> number
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the coordinates of the circumcircle center and its radius.
|
||||
|
||||
Note: This function does not take into account the Y-coordinate,
|
||||
that is, the calculation is performed on the projection of the triangle XZ.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.inCircumCircle2D
|
||||
---
|
||||
```lua
|
||||
function Triangle.inCircumCircle2D(p: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}) -> boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Checks if a given point lies into the triangle circumcircle.
|
||||
|
||||
Note: This function does not take into account the Y-coordinate,
|
||||
that is, the calculation is performed on the projection of the triangle XZ.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### Triangle.p1
|
||||
---
|
||||
```lua
|
||||
Triangle.p1 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.p2
|
||||
---
|
||||
```lua
|
||||
Triangle.p2 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.p3
|
||||
---
|
||||
```lua
|
||||
Triangle.p3 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.e1
|
||||
---
|
||||
```lua
|
||||
Triangle.e1 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.e2
|
||||
---
|
||||
```lua
|
||||
Triangle.e2 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.e3
|
||||
---
|
||||
```lua
|
||||
Triangle.e3 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.h1
|
||||
---
|
||||
```lua
|
||||
Triangle.h1 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.h2
|
||||
---
|
||||
```lua
|
||||
Triangle.h2 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.h3
|
||||
---
|
||||
```lua
|
||||
Triangle.h3 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.neighbours
|
||||
---
|
||||
```lua
|
||||
Triangle.neighbours : MapGen.Triangle.Neighbours
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.color
|
||||
---
|
||||
```lua
|
||||
Triangle.color : ColorString?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
225
docs/docs/modules/MapGen.Triangulation.Edge.md
Normal file
225
docs/docs/modules/MapGen.Triangulation.Edge.md
Normal file
@@ -0,0 +1,225 @@
|
||||
# global MapGen.Triangulation.Edge
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Edge.new
|
||||
---
|
||||
```lua
|
||||
function Edge.new(
|
||||
p1: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p2: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
) -> MapGen.Triangulation.Edge {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
same = function,
|
||||
length = function,
|
||||
getMidPoint = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Edge.toString
|
||||
---
|
||||
```lua
|
||||
function Edge.toString() -> string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns a string describing the object in a readable form.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Edge.eq
|
||||
---
|
||||
```lua
|
||||
function Edge.eq(other: MapGen.Triangulation.Edge {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
same = function,
|
||||
length = function,
|
||||
getMidPoint = function,
|
||||
}) -> boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns true if the edges are equivalent.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Edge.same
|
||||
---
|
||||
```lua
|
||||
function Edge.same(other: MapGen.Triangulation.Edge {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
same = function,
|
||||
length = function,
|
||||
getMidPoint = function,
|
||||
}) -> boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns true if the edges are similar.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Edge.length
|
||||
---
|
||||
```lua
|
||||
function Edge.length() -> number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the length of an edge.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Edge.getMidPoint
|
||||
---
|
||||
```lua
|
||||
function Edge.getMidPoint() -> vector
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the vector of the point located in the middle of the edge.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### Edge.p1
|
||||
---
|
||||
```lua
|
||||
Edge.p1 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Edge.p2
|
||||
---
|
||||
```lua
|
||||
Edge.p2 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
79
docs/docs/modules/MapGen.Triangulation.FakePeak.md
Normal file
79
docs/docs/modules/MapGen.Triangulation.FakePeak.md
Normal file
@@ -0,0 +1,79 @@
|
||||
# global MapGen.Triangulation.FakePeak
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### FakePeak.getPeakPos
|
||||
---
|
||||
```lua
|
||||
function FakePeak.getPeakPos()-> vector
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### FakePeak.new
|
||||
---
|
||||
```lua
|
||||
function FakePeak.new(peakPos: vector) -> MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns a fake `MapGen.Peak` that has no noise parameters.
|
||||
Note that the initialized peak should not be used in generation.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### FakePeak.id
|
||||
---
|
||||
```lua
|
||||
FakePeak.id : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
81
docs/docs/modules/MapGen.Triangulation.md
Normal file
81
docs/docs/modules/MapGen.Triangulation.md
Normal file
@@ -0,0 +1,81 @@
|
||||
# global MapGen.Triangulation
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Triangulation.triangulate
|
||||
---
|
||||
```lua
|
||||
function Triangulation.triangulate(vertices: table<integer,MapGen.Peak>) -> ((MapGen.Triangle)|MapGen.Triangle[])
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
The Delaunay method divides a plane into triangles based on a list of their vertices.
|
||||
|
||||
Doesn't take into account the Y coordinate of the vertices.
|
||||
That is, all triangles that don't lie in the XZ plane will be projected onto it.
|
||||
|
||||
Vertices that do not have a `is2d` group will not participate in the triangulation.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangulation.tetrahedralize
|
||||
---
|
||||
```lua
|
||||
function Triangulation.tetrahedralize(vertices: table<integer,MapGen.Peak>) -> ((MapGen.Tetrahedron)|MapGen.Tetrahedron[])
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
The Delaunay method divides space into tetrahedra based on a list of their vertices.
|
||||
|
||||
Vertices that do not have a `is3d` group will not participate in the triangulation.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### Triangulation.convexMultiplier
|
||||
---
|
||||
```lua
|
||||
Triangulation.convexMultiplier : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
30
docs/docs/modules/MapGen.ff2luat.md
Normal file
30
docs/docs/modules/MapGen.ff2luat.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# global MapGen.ff2luat
|
||||
|
||||
|
||||
Converts given farbfeld image to ColoredDotsTable.
|
||||
Farbfeld format:
|
||||
```
|
||||
╔════════╤═════════════════════════════════════════════════════════╗
|
||||
║ Bytes │ Description ║
|
||||
╠════════╪═════════════════════════════════════════════════════════╣
|
||||
║ 8 │ 'farbfeld' magic value ║
|
||||
╟────────┼─────────────────────────────────────────────────────────╢
|
||||
║ 4 │ 32-Bit BE unsigned integer (width) ║
|
||||
╟────────┼─────────────────────────────────────────────────────────╢
|
||||
║ 4 │ 32-Bit BE unsigned integer (height) ║
|
||||
╟────────┼─────────────────────────────────────────────────────────╢
|
||||
║ [2222] │ 4x16-Bit BE unsigned integers [RGBA] / pixel, row-major ║
|
||||
╚════════╧═════════════════════════════════════════════════════════╝
|
||||
```
|
||||
[tools/farbfeld | suckless.org software that sucks less](https://tools.suckless.org/farbfeld/)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
738
docs/docs/modules/MapGen.md
Normal file
738
docs/docs/modules/MapGen.md
Normal file
@@ -0,0 +1,738 @@
|
||||
# global MapGen
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### MapGen.new
|
||||
---
|
||||
```lua
|
||||
function MapGen.new(def: MapGenDef {
|
||||
nodes = table<string,string>,
|
||||
}) -> MapGen {
|
||||
layersByName = table<string,MapGen.Layer>,
|
||||
layersList = MapGen.Layer[],
|
||||
staticsByName = table<string,MapGen.StaticLayer>,
|
||||
staticsList = MapGen.StaticLayer[],
|
||||
layersNoisesInitialized = boolean,
|
||||
cavernsNoiseInitialized = boolean,
|
||||
isRunning = boolean,
|
||||
nodeIDs = table<string,number>,
|
||||
new = function,
|
||||
getLayerByHeight = function,
|
||||
getStaticByHeight = function,
|
||||
registerLayer = function,
|
||||
registerLayerNoiseColor = function,
|
||||
registerStaticLayer = function,
|
||||
registerPeak = function,
|
||||
register2DPeak = function,
|
||||
register2DPeaks = function,
|
||||
register2DPeaksFromFile = function,
|
||||
registerBiome = function,
|
||||
registerCavern = function,
|
||||
initLayersTriangultaion = function,
|
||||
initLayersNoises = function,
|
||||
initBiomesDiagram = function,
|
||||
initCavernsNoise = function,
|
||||
getNoises2dValue = function,
|
||||
onMapGenerated = function,
|
||||
run = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.getLayerByHeight
|
||||
---
|
||||
```lua
|
||||
function MapGen.getLayerByHeight(yPos: number) -> MapGen.Layer?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Determines which layer a node belongs to based on its height coordinate.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.getStaticByHeight
|
||||
---
|
||||
```lua
|
||||
function MapGen.getStaticByHeight(yPos: number) -> MapGen.StaticLayer?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Determines which statics layer a node belongs to based on its height coordinate.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.registerLayer
|
||||
---
|
||||
```lua
|
||||
function MapGen.registerLayer(
|
||||
name: string,
|
||||
def: MapGen.LayerDef {
|
||||
minY = number,
|
||||
maxY = number,
|
||||
minTemp = number,
|
||||
maxTemp = number,
|
||||
minHumidity = number,
|
||||
maxHumidity = number,
|
||||
waterLevel = number?,
|
||||
calcTemp = (fun(self: MapGen.Layer, value: number, height: number) -> number)?,
|
||||
calcHumidity = (fun(self: MapGen.Layer, value: number, height: number) -> number)?,
|
||||
biomesGorizontalScattering = number?,
|
||||
biomesVerticalScattering = number?,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
@param `name` - The name that will be assigned to the layer. The name must be unique for each layer.
|
||||
|
||||
@param `def` - Layer description table, see details `MapGen.LayerDef`.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Mark the world area between two heights as a `MapGen.Layer`.
|
||||
|
||||
Note: layers must not overlap.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.registerLayerNoiseColor
|
||||
---
|
||||
```lua
|
||||
function MapGen.registerLayerNoiseColor(
|
||||
layerName: string,
|
||||
category: MapGen.Layer.Category,
|
||||
color: ColorString,
|
||||
noiseParams: NoiseParams
|
||||
) -> nil
|
||||
```
|
||||
@param `layerName` - The name of the layer for which the color will be registered.
|
||||
|
||||
@param `category` - Category indicating what will be generated by noise.
|
||||
|
||||
@param `color` - Noise color. Must be unique.
|
||||
|
||||
@param `noiseParams` - Fractal noise parameters.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Register the color and the noise parameters that correspond to it.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.registerStaticLayer
|
||||
---
|
||||
```lua
|
||||
function MapGen.registerStaticLayer(
|
||||
name: string,
|
||||
def: MapGen.StaticLayerDef {
|
||||
minY = number,
|
||||
maxY = number,
|
||||
staticNode = string,
|
||||
generateStaticNode = generateFunc,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
@param `name` - The name that will be assigned to the static layer. The name must be unique for each layer.
|
||||
|
||||
@param `def` - Static layer description table, see details `MapGen.StaticLayerDef`.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Mark the world area between two heights as a `MapGen.StaticLayer`.
|
||||
|
||||
Note: layers must not overlap.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.registerPeak
|
||||
---
|
||||
```lua
|
||||
function MapGen.registerPeak(
|
||||
layerName: string,
|
||||
category: MapGen.Layer.Category,
|
||||
def: MapGen.PeakDef {
|
||||
pos = vector,
|
||||
color = ColorString,
|
||||
groups = table<string,number>?,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
@param `layerName` - The name of the layer in which the new peak will be included.
|
||||
|
||||
@param `category` - Category indicating what will be generated by peak.
|
||||
|
||||
@param `def` - Peak description table, see details `MapGen.PeakDef`.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Mark a world point as `MapGen.Peak` and assign it a specific color that will affect the generation.
|
||||
|
||||
Note: The peaks shouldn't overlap. This won't cause any errors, but it might ruin the generation.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.register2DPeak
|
||||
---
|
||||
```lua
|
||||
function MapGen.register2DPeak(
|
||||
layerName: string,
|
||||
category: MapGen.Layer.Category,
|
||||
def: MapGen.PeakDef {
|
||||
pos = vector,
|
||||
color = ColorString,
|
||||
groups = table<string,number>?,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
@param `layerName` - The name of the layer in which the new peak will be included.
|
||||
|
||||
@param `category` - Category indicating what will be generated by peak.
|
||||
|
||||
@param `def` - Peak description table, see details `MapGen.PeakDef`.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Mark a world point as `MapGen.Peak` and assign it a specific color that will affect the generation.
|
||||
The Y coordinate will be forced to zero, and the `is2d` group will be added to the groups field.
|
||||
|
||||
Note: The peaks shouldn't overlap. This won't cause any errors, but it might ruin the generation.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.register2DPeaks
|
||||
---
|
||||
```lua
|
||||
function MapGen.register2DPeaks(
|
||||
layerName: string,
|
||||
category: MapGen.Layer.Category,
|
||||
defs: MapGen.PeakDef[]
|
||||
) -> nil
|
||||
```
|
||||
@param `layerName` - The name of the layer in which the new peaks will be included.
|
||||
|
||||
@param `category` - Category indicating what will be generated by peaks.
|
||||
|
||||
@param `defs` - Peaks description table, see details `MapGen.PeakDef`.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Mark the world points as `MapGen.Peak` and assign them all a specific noise that will affect generation.
|
||||
The Y coordinate will be forced to zero, and the `is2d` group will be added to the groups field.
|
||||
|
||||
Note: The peaks shouldn't overlap. This won't cause any errors, but it might ruin the generation.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.register2DPeaksFromFile
|
||||
---
|
||||
```lua
|
||||
function MapGen.register2DPeaksFromFile(
|
||||
layerName: string,
|
||||
map: string,
|
||||
scale: number,
|
||||
zeroPos: Position2d,
|
||||
category: MapGen.Layer.Category,
|
||||
groups: table<string,number>?
|
||||
) -> nil
|
||||
```
|
||||
@param `layerName` - The name of the layer in which the new peaks will be included.
|
||||
|
||||
@param `map` - The name of the image from which the peaks will be extracted. It should be located in the `<mod_name>/textures/maps` folder and have the following format `<image_name>.ff`
|
||||
|
||||
@param `scale` - Multiplier of how many blocks (nodes) will be between image pixels. It is not recommended to set the value below 50 for performance reasons.
|
||||
|
||||
@param `zeroPos` - The position in pixels where the zero world coordinate will be in the image.
|
||||
|
||||
@param `category` - Category indicating what will be generated by peaks.
|
||||
|
||||
@param `groups` - Groups that will be added to all peaks.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Extract the `MapGen.Peak` from the image and assign them all a specific color that will affect the generation.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.registerBiome
|
||||
---
|
||||
```lua
|
||||
function MapGen.registerBiome(
|
||||
layerName: string,
|
||||
biomeName: string,
|
||||
def: MapGen.BiomeDef {
|
||||
tempPoint = number,
|
||||
humidityPoint = number,
|
||||
minY = number,
|
||||
maxY = number,
|
||||
groundNodes = MapGen.Biome.GroundNodes,
|
||||
soilHeight = number,
|
||||
generateAir = generateFunc?,
|
||||
generateCavernAir = generateFunc?,
|
||||
generateWater = generateFunc?,
|
||||
generateRock = generateFunc?,
|
||||
generateTurf = generateFunc?,
|
||||
generateSoil = generateFunc?,
|
||||
generateBottom = generateFunc?,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
@param `layerName` - The name of the layer in which the new biome will be included.
|
||||
|
||||
@param `biomeName` - The name to be assigned to the biome. The name must be unique for each biome.
|
||||
|
||||
@param `def` - Biome description table, see details `MapGen.BiomeDef`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Mark a point on the biomes diagram and constrain the world area by height to mark it as `MapGen.Biome`.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.registerCavern
|
||||
---
|
||||
```lua
|
||||
function MapGen.registerCavern(
|
||||
layerName: string,
|
||||
cavernName: string,
|
||||
def: MapGen.CavernDef {
|
||||
minY = number,
|
||||
maxY = number,
|
||||
noiseParams = NoiseParams,
|
||||
smoothDistance = number,
|
||||
threshold = number?,
|
||||
groups = table<string,number>?,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
@param `layerName` - The name of the layer in which the new cavern will be included.
|
||||
|
||||
@param `cavernName` - The name to be assigned to the cavern. The name must be unique for each cavern.
|
||||
|
||||
@param `def` - Cavern description table, see details `MapGen.CavernDef`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Mark the world area between two heights as a `MapGen.Cavern` and assign the noise that the cave will be generated from.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.initLayersTriangultaion
|
||||
---
|
||||
```lua
|
||||
function MapGen.initLayersTriangultaion() -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Divide all layers into triangles whose vertices are the `Mapgen.Peak` belonging to these layers.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.initLayersNoises
|
||||
---
|
||||
```lua
|
||||
function MapGen.initLayersNoises() -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Initialize all layer noises. This should be called after the map object is loaded.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.initBiomesDiagram
|
||||
---
|
||||
```lua
|
||||
function MapGen.initBiomesDiagram() -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Initialization of the biome diagram using the Voronoi method.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.initCavernsNoise
|
||||
---
|
||||
```lua
|
||||
function MapGen.initCavernsNoise() -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Initialize caverns's noises. This should be called after the map object is loaded.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.getNoises2dValue
|
||||
---
|
||||
```lua
|
||||
function MapGen.getNoises2dValue(
|
||||
category: MapGen.Layer.Category,
|
||||
layer: MapGen.Layer {
|
||||
name = string,
|
||||
minY = integer,
|
||||
maxY = integer,
|
||||
minTemp = integer,
|
||||
maxTemp = integer,
|
||||
minHumidity = integer,
|
||||
maxHumidity = integer,
|
||||
waterLevel = integer,
|
||||
peaksList = { humidity: MapGen.Peak[], landscape: MapGen.Peak[], temp: MapGen.Peak[] },
|
||||
noisesByColor = { humidity: table<ColorString,ValueNoise>, landscape: table<ColorString,ValueNoise>, temp: table<ColorString,ValueNoise> },
|
||||
noisesParamsByColor = { humidity: table<ColorString,NoiseParams>, landscape: table<ColorString,NoiseParams>, temp: table<ColorString,NoiseParams> },
|
||||
biomesByName = table<string,MapGen.Biome>,
|
||||
biomesList = MapGen.Biome[],
|
||||
biomesDiagram = table,
|
||||
biomesGorizontalScattering = integer,
|
||||
biomesVerticalScattering = integer,
|
||||
cavernsByName = table<string,MapGen.Cavern>,
|
||||
cavernsList = MapGen.Cavern[],
|
||||
trianglesList = { humidity: MapGen.Triangle[], landscape: MapGen.Triangle[], temp: MapGen.Triangle[] },
|
||||
tetrahedronsList = MapGen.Tetrahedron[],
|
||||
calcTemp = function,
|
||||
calcHumidity = function,
|
||||
new = function,
|
||||
addPeak = function,
|
||||
addNoiseParamsColor = function,
|
||||
getNoiseByColor = function,
|
||||
addBiome = function,
|
||||
addCavern = function,
|
||||
initNoises = function,
|
||||
initBiomesDiagram = function,
|
||||
},
|
||||
x: integer,
|
||||
y: integer,
|
||||
z: integer
|
||||
) -> number?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Calculates a smoothed 2D noise value based on a preliminary space partitioning.
|
||||
|
||||
Returns `nil` if the point is not included in any triangle.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.onMapGenerated
|
||||
---
|
||||
```lua
|
||||
function MapGen.onMapGenerated(
|
||||
voxelManip: VoxelManip,
|
||||
minPos: Position,
|
||||
maxPos: Position,
|
||||
blockseed: number
|
||||
) -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Chunk generation handler.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.run
|
||||
---
|
||||
```lua
|
||||
function MapGen.run() -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Run world generation through this mapgen object
|
||||
|
||||
Note: only one instance of a `MapGen` class can be running.
|
||||
|
||||
**FOR MAPGEN ENVIRONMENT ONLY**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### MapGen.layersByName
|
||||
---
|
||||
```lua
|
||||
MapGen.layersByName : table<string,MapGen.Layer>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.layersList
|
||||
---
|
||||
```lua
|
||||
MapGen.layersList : MapGen.Layer[]
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.staticsByName
|
||||
---
|
||||
```lua
|
||||
MapGen.staticsByName : table<string,MapGen.StaticLayer>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.staticsList
|
||||
---
|
||||
```lua
|
||||
MapGen.staticsList : MapGen.StaticLayer[]
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.layersNoisesInitialized
|
||||
---
|
||||
```lua
|
||||
MapGen.layersNoisesInitialized : boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
Is the fractal noise of the layer initialized? This is necessary for a one-time noise initialization.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.cavernsNoiseInitialized
|
||||
---
|
||||
```lua
|
||||
MapGen.cavernsNoiseInitialized : boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
Is the fractal noise of the caverns initialized? This is necessary for a one-time noise initialization.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.isRunning
|
||||
---
|
||||
```lua
|
||||
MapGen.isRunning : boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
A static field that guarantees that only one instance of the `MapGen` class will work.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.nodeIDs
|
||||
---
|
||||
```lua
|
||||
MapGen.nodeIDs : table<string,number>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
23
docs/docs/types/ColoredDotsTable.md
Normal file
23
docs/docs/types/ColoredDotsTable.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# alias ColoredDotsTable
|
||||
---
|
||||
|
||||
|
||||
|
||||
```lua
|
||||
(alias) ColoredDotsTable = table<string,table>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
Table with color as key and value is table with coordinates of dots. Note: coords begin from 1,1 (not 0,0).
|
||||
Example of table:
|
||||
```lua
|
||||
{
|
||||
'size': { h=256, w=256 },
|
||||
'#fff': { {x=1,y=1}, {x=2,y=2}, ... },
|
||||
'#ff0': { {x=3,y=3}, {x=4,y=4}, ... },
|
||||
...
|
||||
}
|
||||
```
|
||||
|
||||
92
docs/docs/types/MapGen.Biome.GroundNodes.md
Normal file
92
docs/docs/types/MapGen.Biome.GroundNodes.md
Normal file
@@ -0,0 +1,92 @@
|
||||
# class GroundNodes
|
||||
|
||||
|
||||
|
||||
- namespace: MapGen.Biome
|
||||
|
||||
|
||||
|
||||
**Only for EmmyLua.**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### GroundNodes.turf
|
||||
---
|
||||
```lua
|
||||
GroundNodes.turf : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
The soil covering the surface of the biome
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### GroundNodes.soil
|
||||
---
|
||||
```lua
|
||||
GroundNodes.soil : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
The soil beneath the turf. The height of this layer depends on `Biome.soilHeight`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### GroundNodes.rock
|
||||
---
|
||||
```lua
|
||||
GroundNodes.rock : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
The rock found beneath the soil of a biome.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### GroundNodes.bottom
|
||||
---
|
||||
```lua
|
||||
GroundNodes.bottom : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
Covering the bottom of reservoirs.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
92
docs/docs/types/MapGen.Biome.GroundNodesIDs.md
Normal file
92
docs/docs/types/MapGen.Biome.GroundNodesIDs.md
Normal file
@@ -0,0 +1,92 @@
|
||||
# class GroundNodesIDs
|
||||
|
||||
|
||||
|
||||
- namespace: MapGen.Biome
|
||||
|
||||
|
||||
|
||||
**Only for EmmyLua.**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### GroundNodesIDs.turf
|
||||
---
|
||||
```lua
|
||||
GroundNodesIDs.turf : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
The soil covering the surface of the biome
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### GroundNodesIDs.soil
|
||||
---
|
||||
```lua
|
||||
GroundNodesIDs.soil : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
The soil beneath the turf. The height of this layer depends on `Biome.soilHeight`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### GroundNodesIDs.rock
|
||||
---
|
||||
```lua
|
||||
GroundNodesIDs.rock : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
The rock found beneath the soil of a biome.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### GroundNodesIDs.bottom
|
||||
---
|
||||
```lua
|
||||
GroundNodesIDs.bottom : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
Covering the bottom of reservoirs.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
312
docs/docs/types/MapGen.Biome.md
Normal file
312
docs/docs/types/MapGen.Biome.md
Normal file
@@ -0,0 +1,312 @@
|
||||
# class Biome
|
||||
|
||||
|
||||
|
||||
- namespace: MapGen
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Biome.new
|
||||
---
|
||||
```lua
|
||||
function Biome.new(
|
||||
name: string,
|
||||
def: MapGen.BiomeDef {
|
||||
tempPoint = number,
|
||||
humidityPoint = number,
|
||||
minY = number,
|
||||
maxY = number,
|
||||
groundNodes = MapGen.Biome.GroundNodes,
|
||||
soilHeight = number,
|
||||
generateAir = generateFunc?,
|
||||
generateCavernAir = generateFunc?,
|
||||
generateWater = generateFunc?,
|
||||
generateRock = generateFunc?,
|
||||
generateTurf = generateFunc?,
|
||||
generateSoil = generateFunc?,
|
||||
generateBottom = generateFunc?,
|
||||
}
|
||||
) -> MapGen.Biome {
|
||||
name = string,
|
||||
tempPoint = number,
|
||||
humidityPoint = number,
|
||||
minY = number,
|
||||
maxY = number,
|
||||
groundNodes = MapGen.Biome.GroundNodes,
|
||||
groundNodesIDs = MapGen.Biome.GroundNodesIDs,
|
||||
soilHeight = number,
|
||||
generateAir = generateFunc,
|
||||
generateCavernAir = generateFunc,
|
||||
generateWater = generateFunc,
|
||||
generateRock = generateFunc,
|
||||
generateTurf = generateFunc,
|
||||
generateSoil = generateFunc,
|
||||
generateBottom = generateFunc,
|
||||
new = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### Biome.name
|
||||
---
|
||||
```lua
|
||||
Biome.name : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.tempPoint
|
||||
---
|
||||
```lua
|
||||
Biome.tempPoint : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.humidityPoint
|
||||
---
|
||||
```lua
|
||||
Biome.humidityPoint : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.minY
|
||||
---
|
||||
```lua
|
||||
Biome.minY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.maxY
|
||||
---
|
||||
```lua
|
||||
Biome.maxY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.groundNodes
|
||||
---
|
||||
```lua
|
||||
Biome.groundNodes : MapGen.Biome.GroundNodes {
|
||||
turf: string,
|
||||
soil: string,
|
||||
rock: string,
|
||||
bottom: string,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.groundNodesIDs
|
||||
---
|
||||
```lua
|
||||
Biome.groundNodesIDs : MapGen.Biome.GroundNodesIDs {
|
||||
turf: number,
|
||||
soil: number,
|
||||
rock: number,
|
||||
bottom: number,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.soilHeight
|
||||
---
|
||||
```lua
|
||||
Biome.soilHeight : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.generateAir
|
||||
---
|
||||
```lua
|
||||
Biome.generateAir : generateFunc
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.generateCavernAir
|
||||
---
|
||||
```lua
|
||||
Biome.generateCavernAir : generateFunc
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.generateWater
|
||||
---
|
||||
```lua
|
||||
Biome.generateWater : generateFunc
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.generateRock
|
||||
---
|
||||
```lua
|
||||
Biome.generateRock : generateFunc
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.generateTurf
|
||||
---
|
||||
```lua
|
||||
Biome.generateTurf : generateFunc
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.generateSoil
|
||||
---
|
||||
```lua
|
||||
Biome.generateSoil : generateFunc
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Biome.generateBottom
|
||||
---
|
||||
```lua
|
||||
Biome.generateBottom : generateFunc
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
226
docs/docs/types/MapGen.BiomeDef.md
Normal file
226
docs/docs/types/MapGen.BiomeDef.md
Normal file
@@ -0,0 +1,226 @@
|
||||
# class BiomeDef
|
||||
|
||||
|
||||
|
||||
- namespace: MapGen
|
||||
|
||||
|
||||
|
||||
Definition table for the `MapGen.Biome`.
|
||||
|
||||
**Only for EmmyLua.**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### BiomeDef.tempPoint
|
||||
---
|
||||
```lua
|
||||
BiomeDef.tempPoint : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### BiomeDef.humidityPoint
|
||||
---
|
||||
```lua
|
||||
BiomeDef.humidityPoint : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### BiomeDef.minY
|
||||
---
|
||||
```lua
|
||||
BiomeDef.minY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### BiomeDef.maxY
|
||||
---
|
||||
```lua
|
||||
BiomeDef.maxY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### BiomeDef.groundNodes
|
||||
---
|
||||
```lua
|
||||
BiomeDef.groundNodes : MapGen.Biome.GroundNodes {
|
||||
turf: string,
|
||||
soil: string,
|
||||
rock: string,
|
||||
bottom: string,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### BiomeDef.soilHeight
|
||||
---
|
||||
```lua
|
||||
BiomeDef.soilHeight : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### BiomeDef.generateAir
|
||||
---
|
||||
```lua
|
||||
BiomeDef.generateAir : generateFunc?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### BiomeDef.generateCavernAir
|
||||
---
|
||||
```lua
|
||||
BiomeDef.generateCavernAir : generateFunc?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### BiomeDef.generateWater
|
||||
---
|
||||
```lua
|
||||
BiomeDef.generateWater : generateFunc?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### BiomeDef.generateRock
|
||||
---
|
||||
```lua
|
||||
BiomeDef.generateRock : generateFunc?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### BiomeDef.generateTurf
|
||||
---
|
||||
```lua
|
||||
BiomeDef.generateTurf : generateFunc?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### BiomeDef.generateSoil
|
||||
---
|
||||
```lua
|
||||
BiomeDef.generateSoil : generateFunc?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### BiomeDef.generateBottom
|
||||
---
|
||||
```lua
|
||||
BiomeDef.generateBottom : generateFunc?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
208
docs/docs/types/MapGen.Cavern.md
Normal file
208
docs/docs/types/MapGen.Cavern.md
Normal file
@@ -0,0 +1,208 @@
|
||||
# class Cavern
|
||||
|
||||
|
||||
|
||||
- namespace: MapGen
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Cavern.getNoise
|
||||
---
|
||||
```lua
|
||||
function Cavern.getNoise()-> ValueNoise
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Cavern.initNoise
|
||||
---
|
||||
```lua
|
||||
function Cavern.initNoise()-> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Cavern.getGroups
|
||||
---
|
||||
```lua
|
||||
function Cavern.getGroups()
|
||||
-> table<string,number>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Cavern.new
|
||||
---
|
||||
```lua
|
||||
function Cavern.new(
|
||||
name: string,
|
||||
def: MapGen.CavernDef {
|
||||
minY = number,
|
||||
maxY = number,
|
||||
noiseParams = NoiseParams,
|
||||
smoothDistance = number,
|
||||
threshold = number?,
|
||||
groups = table<string,number>?,
|
||||
}
|
||||
) -> MapGen.Cavern {
|
||||
name = string,
|
||||
minY = number,
|
||||
maxY = number,
|
||||
smoothDistance = number,
|
||||
threshold = number,
|
||||
getNoise = function,
|
||||
initNoise = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
isCavern = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Cavern.isCavern
|
||||
---
|
||||
```lua
|
||||
function Cavern.isCavern(
|
||||
x: integer,
|
||||
y: integer,
|
||||
z: integer
|
||||
) -> boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns `true` if there is a cavern at the specified coordinates.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### Cavern.name
|
||||
---
|
||||
```lua
|
||||
Cavern.name : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Cavern.minY
|
||||
---
|
||||
```lua
|
||||
Cavern.minY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Cavern.maxY
|
||||
---
|
||||
```lua
|
||||
Cavern.maxY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Cavern.smoothDistance
|
||||
---
|
||||
```lua
|
||||
Cavern.smoothDistance : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Cavern.threshold
|
||||
---
|
||||
```lua
|
||||
Cavern.threshold : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
116
docs/docs/types/MapGen.CavernDef.md
Normal file
116
docs/docs/types/MapGen.CavernDef.md
Normal file
@@ -0,0 +1,116 @@
|
||||
# class CavernDef
|
||||
|
||||
|
||||
|
||||
- namespace: MapGen
|
||||
|
||||
|
||||
|
||||
Definition table for the `MapGen.Cavern`.
|
||||
|
||||
**Only for EmmyLua.**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### CavernDef.minY
|
||||
---
|
||||
```lua
|
||||
CavernDef.minY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### CavernDef.maxY
|
||||
---
|
||||
```lua
|
||||
CavernDef.maxY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### CavernDef.noiseParams
|
||||
---
|
||||
```lua
|
||||
CavernDef.noiseParams : NoiseParams
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### CavernDef.smoothDistance
|
||||
---
|
||||
```lua
|
||||
CavernDef.smoothDistance : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### CavernDef.threshold
|
||||
---
|
||||
```lua
|
||||
CavernDef.threshold : number?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### CavernDef.groups
|
||||
---
|
||||
```lua
|
||||
CavernDef.groups : table<string,number>?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
43
docs/docs/types/MapGen.Decoration.md
Normal file
43
docs/docs/types/MapGen.Decoration.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# class Decoration
|
||||
|
||||
|
||||
|
||||
- namespace: MapGen
|
||||
|
||||
|
||||
|
||||
**NOT IMPLEMENTED**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Decoration.new
|
||||
---
|
||||
```lua
|
||||
function Decoration.new() -> MapGen.Decoration {
|
||||
new = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
16
docs/docs/types/MapGen.Layer.Category.md
Normal file
16
docs/docs/types/MapGen.Layer.Category.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# alias Category
|
||||
---
|
||||
|
||||
- namespace: MapGen.Layer
|
||||
|
||||
|
||||
|
||||
```lua
|
||||
(alias) Category = ("landscape"|"temp"|"humidity")
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
A category of noise that affects specific map generation objects.
|
||||
|
||||
678
docs/docs/types/MapGen.Layer.md
Normal file
678
docs/docs/types/MapGen.Layer.md
Normal file
@@ -0,0 +1,678 @@
|
||||
# class Layer
|
||||
|
||||
|
||||
|
||||
- namespace: MapGen
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Layer.calcTemp
|
||||
---
|
||||
```lua
|
||||
function Layer.calcTemp(
|
||||
self: MapGen.Layer {
|
||||
name = string,
|
||||
minY = integer,
|
||||
maxY = integer,
|
||||
minTemp = integer,
|
||||
maxTemp = integer,
|
||||
minHumidity = integer,
|
||||
maxHumidity = integer,
|
||||
waterLevel = integer,
|
||||
peaksList = { humidity: MapGen.Peak[], landscape: MapGen.Peak[], temp: MapGen.Peak[] },
|
||||
noisesByColor = { humidity: table<ColorString,ValueNoise>, landscape: table<ColorString,ValueNoise>, temp: table<ColorString,ValueNoise> },
|
||||
noisesParamsByColor = { humidity: table<ColorString,NoiseParams>, landscape: table<ColorString,NoiseParams>, temp: table<ColorString,NoiseParams> },
|
||||
biomesByName = table<string,MapGen.Biome>,
|
||||
biomesList = MapGen.Biome[],
|
||||
biomesDiagram = table,
|
||||
biomesGorizontalScattering = integer,
|
||||
biomesVerticalScattering = integer,
|
||||
cavernsByName = table<string,MapGen.Cavern>,
|
||||
cavernsList = MapGen.Cavern[],
|
||||
trianglesList = { humidity: MapGen.Triangle[], landscape: MapGen.Triangle[], temp: MapGen.Triangle[] },
|
||||
tetrahedronsList = MapGen.Tetrahedron[],
|
||||
calcTemp = function,
|
||||
calcHumidity = function,
|
||||
new = function,
|
||||
addPeak = function,
|
||||
addNoiseParamsColor = function,
|
||||
getNoiseByColor = function,
|
||||
addBiome = function,
|
||||
addCavern = function,
|
||||
initNoises = function,
|
||||
initBiomesDiagram = function,
|
||||
},
|
||||
value: number,
|
||||
height: number
|
||||
)-> number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.calcHumidity
|
||||
---
|
||||
```lua
|
||||
function Layer.calcHumidity(
|
||||
self: MapGen.Layer {
|
||||
name = string,
|
||||
minY = integer,
|
||||
maxY = integer,
|
||||
minTemp = integer,
|
||||
maxTemp = integer,
|
||||
minHumidity = integer,
|
||||
maxHumidity = integer,
|
||||
waterLevel = integer,
|
||||
peaksList = { humidity: MapGen.Peak[], landscape: MapGen.Peak[], temp: MapGen.Peak[] },
|
||||
noisesByColor = { humidity: table<ColorString,ValueNoise>, landscape: table<ColorString,ValueNoise>, temp: table<ColorString,ValueNoise> },
|
||||
noisesParamsByColor = { humidity: table<ColorString,NoiseParams>, landscape: table<ColorString,NoiseParams>, temp: table<ColorString,NoiseParams> },
|
||||
biomesByName = table<string,MapGen.Biome>,
|
||||
biomesList = MapGen.Biome[],
|
||||
biomesDiagram = table,
|
||||
biomesGorizontalScattering = integer,
|
||||
biomesVerticalScattering = integer,
|
||||
cavernsByName = table<string,MapGen.Cavern>,
|
||||
cavernsList = MapGen.Cavern[],
|
||||
trianglesList = { humidity: MapGen.Triangle[], landscape: MapGen.Triangle[], temp: MapGen.Triangle[] },
|
||||
tetrahedronsList = MapGen.Tetrahedron[],
|
||||
calcTemp = function,
|
||||
calcHumidity = function,
|
||||
new = function,
|
||||
addPeak = function,
|
||||
addNoiseParamsColor = function,
|
||||
getNoiseByColor = function,
|
||||
addBiome = function,
|
||||
addCavern = function,
|
||||
initNoises = function,
|
||||
initBiomesDiagram = function,
|
||||
},
|
||||
value: number,
|
||||
height: number
|
||||
)-> number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.new
|
||||
---
|
||||
```lua
|
||||
function Layer.new(
|
||||
name: string,
|
||||
def: MapGen.LayerDef {
|
||||
minY = number,
|
||||
maxY = number,
|
||||
minTemp = number,
|
||||
maxTemp = number,
|
||||
minHumidity = number,
|
||||
maxHumidity = number,
|
||||
waterLevel = number?,
|
||||
calcTemp = (fun(self: MapGen.Layer, value: number, height: number) -> number)?,
|
||||
calcHumidity = (fun(self: MapGen.Layer, value: number, height: number) -> number)?,
|
||||
biomesGorizontalScattering = number?,
|
||||
biomesVerticalScattering = number?,
|
||||
}
|
||||
) -> MapGen.Layer {
|
||||
name = string,
|
||||
minY = integer,
|
||||
maxY = integer,
|
||||
minTemp = integer,
|
||||
maxTemp = integer,
|
||||
minHumidity = integer,
|
||||
maxHumidity = integer,
|
||||
waterLevel = integer,
|
||||
peaksList = { humidity: MapGen.Peak[], landscape: MapGen.Peak[], temp: MapGen.Peak[] },
|
||||
noisesByColor = { humidity: table<ColorString,ValueNoise>, landscape: table<ColorString,ValueNoise>, temp: table<ColorString,ValueNoise> },
|
||||
noisesParamsByColor = { humidity: table<ColorString,NoiseParams>, landscape: table<ColorString,NoiseParams>, temp: table<ColorString,NoiseParams> },
|
||||
biomesByName = table<string,MapGen.Biome>,
|
||||
biomesList = MapGen.Biome[],
|
||||
biomesDiagram = table,
|
||||
biomesGorizontalScattering = integer,
|
||||
biomesVerticalScattering = integer,
|
||||
cavernsByName = table<string,MapGen.Cavern>,
|
||||
cavernsList = MapGen.Cavern[],
|
||||
trianglesList = { humidity: MapGen.Triangle[], landscape: MapGen.Triangle[], temp: MapGen.Triangle[] },
|
||||
tetrahedronsList = MapGen.Tetrahedron[],
|
||||
calcTemp = function,
|
||||
calcHumidity = function,
|
||||
new = function,
|
||||
addPeak = function,
|
||||
addNoiseParamsColor = function,
|
||||
getNoiseByColor = function,
|
||||
addBiome = function,
|
||||
addCavern = function,
|
||||
initNoises = function,
|
||||
initBiomesDiagram = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.addPeak
|
||||
---
|
||||
```lua
|
||||
function Layer.addPeak(
|
||||
category: MapGen.Layer.Category,
|
||||
peak: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Adds a peak to the `Layer.peaksList`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.addNoiseParamsColor
|
||||
---
|
||||
```lua
|
||||
function Layer.addNoiseParamsColor(
|
||||
category: MapGen.Layer.Category,
|
||||
color: ColorString,
|
||||
noiseParams: NoiseParams
|
||||
) -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Adds a NoiseParams color to the `Layer.noisesParamsByColor`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.getNoiseByColor
|
||||
---
|
||||
```lua
|
||||
function Layer.getNoiseByColor(
|
||||
category: MapGen.Layer.Category,
|
||||
color: ColorString
|
||||
) -> ValueNoise
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns noise corresponding to a color.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.addBiome
|
||||
---
|
||||
```lua
|
||||
function Layer.addBiome(
|
||||
biomeName: string,
|
||||
biome: MapGen.Biome {
|
||||
name = string,
|
||||
tempPoint = number,
|
||||
humidityPoint = number,
|
||||
minY = number,
|
||||
maxY = number,
|
||||
groundNodes = MapGen.Biome.GroundNodes,
|
||||
groundNodesIDs = MapGen.Biome.GroundNodesIDs,
|
||||
soilHeight = number,
|
||||
generateAir = generateFunc,
|
||||
generateCavernAir = generateFunc,
|
||||
generateWater = generateFunc,
|
||||
generateRock = generateFunc,
|
||||
generateTurf = generateFunc,
|
||||
generateSoil = generateFunc,
|
||||
generateBottom = generateFunc,
|
||||
new = function,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Adds a biome to the `Layer.biomesByName` & `Layer.biomesList`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.addCavern
|
||||
---
|
||||
```lua
|
||||
function Layer.addCavern(
|
||||
cavernName: string,
|
||||
cavern: MapGen.Cavern {
|
||||
name = string,
|
||||
minY = number,
|
||||
maxY = number,
|
||||
smoothDistance = number,
|
||||
threshold = number,
|
||||
getNoise = function,
|
||||
initNoise = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
isCavern = function,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Adds a cavern to the `Layer.cavernsByName` & `Layer.cavernsList`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.initNoises
|
||||
---
|
||||
```lua
|
||||
function Layer.initNoises() -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Initializes noise for generation.
|
||||
|
||||
Should only be called after the mapgen object has been loaded.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.initBiomesDiagram
|
||||
---
|
||||
```lua
|
||||
function Layer.initBiomesDiagram() -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Initialization of the biome diagram using the Voronoi method.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### Layer.name
|
||||
---
|
||||
```lua
|
||||
Layer.name : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.minY
|
||||
---
|
||||
```lua
|
||||
Layer.minY : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.maxY
|
||||
---
|
||||
```lua
|
||||
Layer.maxY : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.minTemp
|
||||
---
|
||||
```lua
|
||||
Layer.minTemp : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.maxTemp
|
||||
---
|
||||
```lua
|
||||
Layer.maxTemp : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.minHumidity
|
||||
---
|
||||
```lua
|
||||
Layer.minHumidity : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.maxHumidity
|
||||
---
|
||||
```lua
|
||||
Layer.maxHumidity : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.waterLevel
|
||||
---
|
||||
```lua
|
||||
Layer.waterLevel : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.peaksList
|
||||
---
|
||||
```lua
|
||||
Layer.peaksList : { humidity: MapGen.Peak[], landscape: MapGen.Peak[], temp: MapGen.Peak[] }
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.noisesByColor
|
||||
---
|
||||
```lua
|
||||
Layer.noisesByColor : { humidity: table<ColorString,ValueNoise>, landscape: table<ColorString,ValueNoise>, temp: table<ColorString,ValueNoise> }
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.noisesParamsByColor
|
||||
---
|
||||
```lua
|
||||
Layer.noisesParamsByColor : { humidity: table<ColorString,NoiseParams>, landscape: table<ColorString,NoiseParams>, temp: table<ColorString,NoiseParams> }
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.biomesByName
|
||||
---
|
||||
```lua
|
||||
Layer.biomesByName : table<string,MapGen.Biome>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.biomesList
|
||||
---
|
||||
```lua
|
||||
Layer.biomesList : MapGen.Biome[]
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.biomesDiagram
|
||||
---
|
||||
```lua
|
||||
Layer.biomesDiagram : table
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.biomesGorizontalScattering
|
||||
---
|
||||
```lua
|
||||
Layer.biomesGorizontalScattering : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.biomesVerticalScattering
|
||||
---
|
||||
```lua
|
||||
Layer.biomesVerticalScattering : integer
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.cavernsByName
|
||||
---
|
||||
```lua
|
||||
Layer.cavernsByName : table<string,MapGen.Cavern>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.cavernsList
|
||||
---
|
||||
```lua
|
||||
Layer.cavernsList : MapGen.Cavern[]
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.trianglesList
|
||||
---
|
||||
```lua
|
||||
Layer.trianglesList : { humidity: MapGen.Triangle[], landscape: MapGen.Triangle[], temp: MapGen.Triangle[] }
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Layer.tetrahedronsList
|
||||
---
|
||||
```lua
|
||||
Layer.tetrahedronsList : MapGen.Tetrahedron[]
|
||||
```
|
||||
|
||||
|
||||
|
||||
**Not supported**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
191
docs/docs/types/MapGen.LayerDef.md
Normal file
191
docs/docs/types/MapGen.LayerDef.md
Normal file
@@ -0,0 +1,191 @@
|
||||
# class LayerDef
|
||||
|
||||
|
||||
|
||||
- namespace: MapGen
|
||||
|
||||
|
||||
|
||||
Definition table for the `MapGen.Layer`.
|
||||
|
||||
**Only for EmmyLua.**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### LayerDef.minY
|
||||
---
|
||||
```lua
|
||||
LayerDef.minY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### LayerDef.maxY
|
||||
---
|
||||
```lua
|
||||
LayerDef.maxY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### LayerDef.minTemp
|
||||
---
|
||||
```lua
|
||||
LayerDef.minTemp : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### LayerDef.maxTemp
|
||||
---
|
||||
```lua
|
||||
LayerDef.maxTemp : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### LayerDef.minHumidity
|
||||
---
|
||||
```lua
|
||||
LayerDef.minHumidity : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### LayerDef.maxHumidity
|
||||
---
|
||||
```lua
|
||||
LayerDef.maxHumidity : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### LayerDef.waterLevel
|
||||
---
|
||||
```lua
|
||||
LayerDef.waterLevel : number?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### LayerDef.calcTemp
|
||||
---
|
||||
```lua
|
||||
LayerDef.calcTemp : (fun(self: MapGen.Layer, value: number, height: number) -> number)?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### LayerDef.calcHumidity
|
||||
---
|
||||
```lua
|
||||
LayerDef.calcHumidity : (fun(self: MapGen.Layer, value: number, height: number) -> number)?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### LayerDef.biomesGorizontalScattering
|
||||
---
|
||||
```lua
|
||||
LayerDef.biomesGorizontalScattering : number?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### LayerDef.biomesVerticalScattering
|
||||
---
|
||||
```lua
|
||||
LayerDef.biomesVerticalScattering : number?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
14
docs/docs/types/MapGen.PastCalcNoiseValue.md
Normal file
14
docs/docs/types/MapGen.PastCalcNoiseValue.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# alias PastCalcNoiseValue
|
||||
---
|
||||
|
||||
- namespace: MapGen
|
||||
|
||||
|
||||
|
||||
```lua
|
||||
(alias) PastCalcNoiseValue = { noiseValue: number?, triangle: MapGen.Triangle?, x: integer?, z: integer? }
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
162
docs/docs/types/MapGen.Peak.md
Normal file
162
docs/docs/types/MapGen.Peak.md
Normal file
@@ -0,0 +1,162 @@
|
||||
# class Peak
|
||||
|
||||
|
||||
|
||||
- namespace: MapGen
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Peak.getPeakPos
|
||||
---
|
||||
```lua
|
||||
function Peak.getPeakPos(self)-> vector
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Peak.getColor
|
||||
---
|
||||
```lua
|
||||
function Peak.getColor(self)-> ColorString
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Peak.getGroups
|
||||
---
|
||||
```lua
|
||||
function Peak.getGroups(self)
|
||||
-> table<string,number>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Peak.new
|
||||
---
|
||||
```lua
|
||||
function Peak.new(def: MapGen.PeakDef {
|
||||
pos = vector,
|
||||
color = ColorString,
|
||||
groups = table<string,number>?,
|
||||
}) -> MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Peak.toString
|
||||
---
|
||||
```lua
|
||||
function Peak.toString() -> string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns a string describing the object in a readable form.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Peak.eq
|
||||
---
|
||||
```lua
|
||||
function Peak.eq(other: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}) -> boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns true if the peaks are equivalent.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### Peak.id
|
||||
---
|
||||
```lua
|
||||
Peak.id : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
71
docs/docs/types/MapGen.PeakDef.md
Normal file
71
docs/docs/types/MapGen.PeakDef.md
Normal file
@@ -0,0 +1,71 @@
|
||||
# class PeakDef
|
||||
|
||||
|
||||
|
||||
- namespace: MapGen
|
||||
|
||||
|
||||
|
||||
Definition table for the `MapGen.Peak`.
|
||||
|
||||
**Only for EmmyLua.**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### PeakDef.pos
|
||||
---
|
||||
```lua
|
||||
PeakDef.pos : vector
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### PeakDef.color
|
||||
---
|
||||
```lua
|
||||
PeakDef.color : ColorString
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### PeakDef.groups
|
||||
---
|
||||
```lua
|
||||
PeakDef.groups : table<string,number>?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
149
docs/docs/types/MapGen.StaticLayer.md
Normal file
149
docs/docs/types/MapGen.StaticLayer.md
Normal file
@@ -0,0 +1,149 @@
|
||||
# class StaticLayer
|
||||
|
||||
|
||||
|
||||
- namespace: MapGen
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### StaticLayer.new
|
||||
---
|
||||
```lua
|
||||
function StaticLayer.new(
|
||||
name: string,
|
||||
def: MapGen.StaticLayerDef {
|
||||
minY = number,
|
||||
maxY = number,
|
||||
staticNode = string,
|
||||
generateStaticNode = generateFunc,
|
||||
}
|
||||
) -> MapGen.StaticLayer {
|
||||
name = string,
|
||||
minY = number,
|
||||
maxY = number,
|
||||
staticNode = string,
|
||||
staticNodeID = number,
|
||||
generateStaticNode = generateFunc,
|
||||
new = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### StaticLayer.name
|
||||
---
|
||||
```lua
|
||||
StaticLayer.name : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### StaticLayer.minY
|
||||
---
|
||||
```lua
|
||||
StaticLayer.minY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### StaticLayer.maxY
|
||||
---
|
||||
```lua
|
||||
StaticLayer.maxY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### StaticLayer.staticNode
|
||||
---
|
||||
```lua
|
||||
StaticLayer.staticNode : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### StaticLayer.staticNodeID
|
||||
---
|
||||
```lua
|
||||
StaticLayer.staticNodeID : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### StaticLayer.generateStaticNode
|
||||
---
|
||||
```lua
|
||||
StaticLayer.generateStaticNode : generateFunc
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
86
docs/docs/types/MapGen.StaticLayerDef.md
Normal file
86
docs/docs/types/MapGen.StaticLayerDef.md
Normal file
@@ -0,0 +1,86 @@
|
||||
# class StaticLayerDef
|
||||
|
||||
|
||||
|
||||
- namespace: MapGen
|
||||
|
||||
|
||||
|
||||
Definition table for the `MapGen.StaticLayer`.
|
||||
|
||||
**Only for EmmyLua.**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### StaticLayerDef.minY
|
||||
---
|
||||
```lua
|
||||
StaticLayerDef.minY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### StaticLayerDef.maxY
|
||||
---
|
||||
```lua
|
||||
StaticLayerDef.maxY : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### StaticLayerDef.staticNode
|
||||
---
|
||||
```lua
|
||||
StaticLayerDef.staticNode : string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### StaticLayerDef.generateStaticNode
|
||||
---
|
||||
```lua
|
||||
StaticLayerDef.generateStaticNode : generateFunc
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
541
docs/docs/types/MapGen.Tetrahedron.md
Normal file
541
docs/docs/types/MapGen.Tetrahedron.md
Normal file
@@ -0,0 +1,541 @@
|
||||
# class Tetrahedron
|
||||
|
||||
|
||||
|
||||
- namespace: MapGen
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Tetrahedron.new
|
||||
---
|
||||
```lua
|
||||
function Tetrahedron.new(
|
||||
p1: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p2: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p3: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p4: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
) -> MapGen.Tetrahedron {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
p3 = MapGen.Peak,
|
||||
p4 = MapGen.Peak,
|
||||
h1 = MapGen.Triangulation.Edge,
|
||||
h2 = MapGen.Triangulation.Edge,
|
||||
h3 = MapGen.Triangulation.Edge,
|
||||
h4 = MapGen.Triangulation.Edge,
|
||||
f1 = MapGen.Triangle,
|
||||
f2 = MapGen.Triangle,
|
||||
f3 = MapGen.Triangle,
|
||||
f4 = MapGen.Triangle,
|
||||
new = function,
|
||||
toString = function,
|
||||
getHeight = function,
|
||||
getCircumSphereCenter = function,
|
||||
getCircumSphereRadius = function,
|
||||
inCircumSphere = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.toString
|
||||
---
|
||||
```lua
|
||||
function Tetrahedron.toString() -> string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns a string describing the object in a readable form.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.getHeight
|
||||
---
|
||||
```lua
|
||||
function Tetrahedron.getHeight(
|
||||
p1: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p2: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p3: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p4: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
) -> MapGen.Triangulation.Edge?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.getCircumSphereCenter
|
||||
---
|
||||
```lua
|
||||
function Tetrahedron.getCircumSphereCenter() -> vector
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the center of the circumscribed sphere.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.getCircumSphereRadius
|
||||
---
|
||||
```lua
|
||||
function Tetrahedron.getCircumSphereRadius() -> number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the radius of the circumscribed sphere.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.inCircumSphere
|
||||
---
|
||||
```lua
|
||||
function Tetrahedron.inCircumSphere(p: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}) -> boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Checks whether a given point lies within the circumscribed sphere of a tetrahedron.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### Tetrahedron.p1
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.p1 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.p2
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.p2 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.p3
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.p3 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.p4
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.p4 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.h1
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.h1 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.h2
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.h2 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.h3
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.h3 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.h4
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.h4 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.f1
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.f1 : MapGen.Triangle {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
p3: MapGen.Peak,
|
||||
e1: MapGen.Triangulation.Edge,
|
||||
e2: MapGen.Triangulation.Edge,
|
||||
e3: MapGen.Triangulation.Edge,
|
||||
h1: MapGen.Triangulation.Edge,
|
||||
h2: MapGen.Triangulation.Edge,
|
||||
h3: MapGen.Triangulation.Edge,
|
||||
neighbours: MapGen.Triangle.Neighbours,
|
||||
color: ColorString?,
|
||||
new: function,
|
||||
...(+13)
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.f2
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.f2 : MapGen.Triangle {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
p3: MapGen.Peak,
|
||||
e1: MapGen.Triangulation.Edge,
|
||||
e2: MapGen.Triangulation.Edge,
|
||||
e3: MapGen.Triangulation.Edge,
|
||||
h1: MapGen.Triangulation.Edge,
|
||||
h2: MapGen.Triangulation.Edge,
|
||||
h3: MapGen.Triangulation.Edge,
|
||||
neighbours: MapGen.Triangle.Neighbours,
|
||||
color: ColorString?,
|
||||
new: function,
|
||||
...(+13)
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.f3
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.f3 : MapGen.Triangle {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
p3: MapGen.Peak,
|
||||
e1: MapGen.Triangulation.Edge,
|
||||
e2: MapGen.Triangulation.Edge,
|
||||
e3: MapGen.Triangulation.Edge,
|
||||
h1: MapGen.Triangulation.Edge,
|
||||
h2: MapGen.Triangulation.Edge,
|
||||
h3: MapGen.Triangulation.Edge,
|
||||
neighbours: MapGen.Triangle.Neighbours,
|
||||
color: ColorString?,
|
||||
new: function,
|
||||
...(+13)
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Tetrahedron.f4
|
||||
---
|
||||
```lua
|
||||
Tetrahedron.f4 : MapGen.Triangle {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
p3: MapGen.Peak,
|
||||
e1: MapGen.Triangulation.Edge,
|
||||
e2: MapGen.Triangulation.Edge,
|
||||
e3: MapGen.Triangulation.Edge,
|
||||
h1: MapGen.Triangulation.Edge,
|
||||
h2: MapGen.Triangulation.Edge,
|
||||
h3: MapGen.Triangulation.Edge,
|
||||
neighbours: MapGen.Triangle.Neighbours,
|
||||
color: ColorString?,
|
||||
new: function,
|
||||
...(+13)
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
14
docs/docs/types/MapGen.Triangle.CircumCircleEnum.md
Normal file
14
docs/docs/types/MapGen.Triangle.CircumCircleEnum.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# alias CircumCircleEnum
|
||||
---
|
||||
|
||||
- namespace: MapGen.Triangle
|
||||
|
||||
|
||||
|
||||
```lua
|
||||
(alias) CircumCircleEnum = ("IN"|"BEHIND"|"ON")
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
19
docs/docs/types/MapGen.Triangle.Neighbours.md
Normal file
19
docs/docs/types/MapGen.Triangle.Neighbours.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# alias Neighbours
|
||||
---
|
||||
|
||||
- namespace: MapGen.Triangle
|
||||
|
||||
|
||||
|
||||
```lua
|
||||
(alias) Neighbours = { t1: MapGen.Triangle?, t2: MapGen.Triangle?, t3: MapGen.Triangle? }
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
Adjacent triangles:
|
||||
* `t1` with a common side p1-p2
|
||||
* `t2` with a common side p2-p3
|
||||
* `t3` with a common side p3-p1
|
||||
|
||||
750
docs/docs/types/MapGen.Triangle.md
Normal file
750
docs/docs/types/MapGen.Triangle.md
Normal file
@@ -0,0 +1,750 @@
|
||||
# class Triangle
|
||||
|
||||
|
||||
|
||||
- namespace: MapGen
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Triangle.new
|
||||
---
|
||||
```lua
|
||||
function Triangle.new(
|
||||
p1: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p2: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p3: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
) -> MapGen.Triangle {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
p3 = MapGen.Peak,
|
||||
e1 = MapGen.Triangulation.Edge,
|
||||
e2 = MapGen.Triangulation.Edge,
|
||||
e3 = MapGen.Triangulation.Edge,
|
||||
h1 = MapGen.Triangulation.Edge,
|
||||
h2 = MapGen.Triangulation.Edge,
|
||||
h3 = MapGen.Triangulation.Edge,
|
||||
neighbours = MapGen.Triangle.Neighbours,
|
||||
color = ColorString?,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
same = function,
|
||||
getCenter = function,
|
||||
getArea = function,
|
||||
getHeight = function,
|
||||
getHeight2D = function,
|
||||
getSidesLength = function,
|
||||
getSidesLength2D = function,
|
||||
getCircumCenter2D = function,
|
||||
getCircumRadius2D = function,
|
||||
getCircumCircle2D = function,
|
||||
inCircumCircle2D = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.toString
|
||||
---
|
||||
```lua
|
||||
function Triangle.toString() -> string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns a string describing the object in a readable form.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.eq
|
||||
---
|
||||
```lua
|
||||
function Triangle.eq(other: MapGen.Triangle {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
p3 = MapGen.Peak,
|
||||
e1 = MapGen.Triangulation.Edge,
|
||||
e2 = MapGen.Triangulation.Edge,
|
||||
e3 = MapGen.Triangulation.Edge,
|
||||
h1 = MapGen.Triangulation.Edge,
|
||||
h2 = MapGen.Triangulation.Edge,
|
||||
h3 = MapGen.Triangulation.Edge,
|
||||
neighbours = MapGen.Triangle.Neighbours,
|
||||
color = ColorString?,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
same = function,
|
||||
getCenter = function,
|
||||
getArea = function,
|
||||
getHeight = function,
|
||||
getHeight2D = function,
|
||||
getSidesLength = function,
|
||||
getSidesLength2D = function,
|
||||
getCircumCenter2D = function,
|
||||
getCircumRadius2D = function,
|
||||
getCircumCircle2D = function,
|
||||
inCircumCircle2D = function,
|
||||
}) -> boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns true if the triangles are equivalent.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.same
|
||||
---
|
||||
```lua
|
||||
function Triangle.same(other: MapGen.Triangle {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
p3 = MapGen.Peak,
|
||||
e1 = MapGen.Triangulation.Edge,
|
||||
e2 = MapGen.Triangulation.Edge,
|
||||
e3 = MapGen.Triangulation.Edge,
|
||||
h1 = MapGen.Triangulation.Edge,
|
||||
h2 = MapGen.Triangulation.Edge,
|
||||
h3 = MapGen.Triangulation.Edge,
|
||||
neighbours = MapGen.Triangle.Neighbours,
|
||||
color = ColorString?,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
same = function,
|
||||
getCenter = function,
|
||||
getArea = function,
|
||||
getHeight = function,
|
||||
getHeight2D = function,
|
||||
getSidesLength = function,
|
||||
getSidesLength2D = function,
|
||||
getCircumCenter2D = function,
|
||||
getCircumRadius2D = function,
|
||||
getCircumCircle2D = function,
|
||||
inCircumCircle2D = function,
|
||||
}) -> boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns true if the triangles are similar.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getCenter
|
||||
---
|
||||
```lua
|
||||
function Triangle.getCenter() -> vector
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the coordinates of the triangle's center.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getArea
|
||||
---
|
||||
```lua
|
||||
function Triangle.getArea() -> number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the area of a triangle.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getHeight
|
||||
---
|
||||
```lua
|
||||
function Triangle.getHeight(
|
||||
p1: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p2: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p3: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
) -> MapGen.Triangulation.Edge {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
same = function,
|
||||
length = function,
|
||||
getMidPoint = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the perpendicular from the vertex Peak1 to the line Peak2-Peak3.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getHeight2D
|
||||
---
|
||||
```lua
|
||||
function Triangle.getHeight2D(
|
||||
p1: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p2: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p3: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
) -> MapGen.Triangulation.Edge {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
same = function,
|
||||
length = function,
|
||||
getMidPoint = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the perpendicular from the vertex Peak1 to the line Peak2-Peak3.
|
||||
|
||||
Note: This function does not take into account the Y-coordinate,
|
||||
that is, the calculation is performed on the projection of the triangle XZ.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getSidesLength
|
||||
---
|
||||
```lua
|
||||
function Triangle.getSidesLength()
|
||||
-> number
|
||||
-> number
|
||||
-> number
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the length of the edges
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getSidesLength2D
|
||||
---
|
||||
```lua
|
||||
function Triangle.getSidesLength2D()
|
||||
-> number
|
||||
-> number
|
||||
-> number
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the length of the edges.
|
||||
|
||||
Note: This function does not take into account the Y-coordinate,
|
||||
that is, the calculation is performed on the projection of the triangle XZ.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getCircumCenter2D
|
||||
---
|
||||
```lua
|
||||
function Triangle.getCircumCenter2D() -> vector
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the coordinates of the circumcircle center.
|
||||
|
||||
Note: This function does not take into account the Y-coordinate,
|
||||
that is, the calculation is performed on the projection of the triangle XZ.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getCircumRadius2D
|
||||
---
|
||||
```lua
|
||||
function Triangle.getCircumRadius2D() -> number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the radius of the circumcircle.
|
||||
|
||||
Note: This function does not take into account the Y-coordinate,
|
||||
that is, the calculation is performed on the projection of the triangle XZ.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.getCircumCircle2D
|
||||
---
|
||||
```lua
|
||||
function Triangle.getCircumCircle2D()
|
||||
-> vector
|
||||
-> number
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the coordinates of the circumcircle center and its radius.
|
||||
|
||||
Note: This function does not take into account the Y-coordinate,
|
||||
that is, the calculation is performed on the projection of the triangle XZ.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.inCircumCircle2D
|
||||
---
|
||||
```lua
|
||||
function Triangle.inCircumCircle2D(p: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}) -> boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Checks if a given point lies into the triangle circumcircle.
|
||||
|
||||
Note: This function does not take into account the Y-coordinate,
|
||||
that is, the calculation is performed on the projection of the triangle XZ.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### Triangle.p1
|
||||
---
|
||||
```lua
|
||||
Triangle.p1 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.p2
|
||||
---
|
||||
```lua
|
||||
Triangle.p2 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.p3
|
||||
---
|
||||
```lua
|
||||
Triangle.p3 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.e1
|
||||
---
|
||||
```lua
|
||||
Triangle.e1 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.e2
|
||||
---
|
||||
```lua
|
||||
Triangle.e2 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.e3
|
||||
---
|
||||
```lua
|
||||
Triangle.e3 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.h1
|
||||
---
|
||||
```lua
|
||||
Triangle.h1 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.h2
|
||||
---
|
||||
```lua
|
||||
Triangle.h2 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.h3
|
||||
---
|
||||
```lua
|
||||
Triangle.h3 : MapGen.Triangulation.Edge {
|
||||
p1: MapGen.Peak,
|
||||
p2: MapGen.Peak,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
same: function,
|
||||
length: function,
|
||||
getMidPoint: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.neighbours
|
||||
---
|
||||
```lua
|
||||
Triangle.neighbours : MapGen.Triangle.Neighbours
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangle.color
|
||||
---
|
||||
```lua
|
||||
Triangle.color : ColorString?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
230
docs/docs/types/MapGen.Triangulation.Edge.md
Normal file
230
docs/docs/types/MapGen.Triangulation.Edge.md
Normal file
@@ -0,0 +1,230 @@
|
||||
# class Edge
|
||||
|
||||
|
||||
|
||||
- namespace: MapGen.Triangulation
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Edge.new
|
||||
---
|
||||
```lua
|
||||
function Edge.new(
|
||||
p1: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
},
|
||||
p2: MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
) -> MapGen.Triangulation.Edge {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
same = function,
|
||||
length = function,
|
||||
getMidPoint = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Edge.toString
|
||||
---
|
||||
```lua
|
||||
function Edge.toString() -> string
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns a string describing the object in a readable form.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Edge.eq
|
||||
---
|
||||
```lua
|
||||
function Edge.eq(other: MapGen.Triangulation.Edge {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
same = function,
|
||||
length = function,
|
||||
getMidPoint = function,
|
||||
}) -> boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns true if the edges are equivalent.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Edge.same
|
||||
---
|
||||
```lua
|
||||
function Edge.same(other: MapGen.Triangulation.Edge {
|
||||
p1 = MapGen.Peak,
|
||||
p2 = MapGen.Peak,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
same = function,
|
||||
length = function,
|
||||
getMidPoint = function,
|
||||
}) -> boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns true if the edges are similar.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Edge.length
|
||||
---
|
||||
```lua
|
||||
function Edge.length() -> number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the length of an edge.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Edge.getMidPoint
|
||||
---
|
||||
```lua
|
||||
function Edge.getMidPoint() -> vector
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns the vector of the point located in the middle of the edge.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### Edge.p1
|
||||
---
|
||||
```lua
|
||||
Edge.p1 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Edge.p2
|
||||
---
|
||||
```lua
|
||||
Edge.p2 : MapGen.Peak {
|
||||
id: number,
|
||||
getPeakPos: function,
|
||||
getColor: function,
|
||||
getGroups: function,
|
||||
new: function,
|
||||
toString: function,
|
||||
eq: function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
90
docs/docs/types/MapGen.Triangulation.FakePeak.md
Normal file
90
docs/docs/types/MapGen.Triangulation.FakePeak.md
Normal file
@@ -0,0 +1,90 @@
|
||||
# class FakePeak
|
||||
|
||||
|
||||
- supers: MapGen.Peak
|
||||
|
||||
|
||||
- namespace: MapGen.Triangulation
|
||||
|
||||
|
||||
|
||||
Allows you to create a `MapGen.Peak` without specifying a noise parameter.
|
||||
|
||||
**WARNING: MUST NOT BE PARTICIPATED IN GENERATION**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### FakePeak.getPeakPos
|
||||
---
|
||||
```lua
|
||||
function FakePeak.getPeakPos()-> vector
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### FakePeak.new
|
||||
---
|
||||
```lua
|
||||
function FakePeak.new(peakPos: vector) -> MapGen.Peak {
|
||||
id = number,
|
||||
getPeakPos = function,
|
||||
getColor = function,
|
||||
getGroups = function,
|
||||
new = function,
|
||||
toString = function,
|
||||
eq = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Returns a fake `MapGen.Peak` that has no noise parameters.
|
||||
Note that the initialized peak should not be used in generation.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### FakePeak.id
|
||||
---
|
||||
```lua
|
||||
FakePeak.id : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
86
docs/docs/types/MapGen.Triangulation.md
Normal file
86
docs/docs/types/MapGen.Triangulation.md
Normal file
@@ -0,0 +1,86 @@
|
||||
# class Triangulation
|
||||
|
||||
|
||||
|
||||
- namespace: MapGen
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### Triangulation.triangulate
|
||||
---
|
||||
```lua
|
||||
function Triangulation.triangulate(vertices: table<integer,MapGen.Peak>) -> ((MapGen.Triangle)|MapGen.Triangle[])
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
The Delaunay method divides a plane into triangles based on a list of their vertices.
|
||||
|
||||
Doesn't take into account the Y coordinate of the vertices.
|
||||
That is, all triangles that don't lie in the XZ plane will be projected onto it.
|
||||
|
||||
Vertices that do not have a `is2d` group will not participate in the triangulation.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Triangulation.tetrahedralize
|
||||
---
|
||||
```lua
|
||||
function Triangulation.tetrahedralize(vertices: table<integer,MapGen.Peak>) -> ((MapGen.Tetrahedron)|MapGen.Tetrahedron[])
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
The Delaunay method divides space into tetrahedra based on a list of their vertices.
|
||||
|
||||
Vertices that do not have a `is3d` group will not participate in the triangulation.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### Triangulation.convexMultiplier
|
||||
---
|
||||
```lua
|
||||
Triangulation.convexMultiplier : number
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
741
docs/docs/types/MapGen.md
Normal file
741
docs/docs/types/MapGen.md
Normal file
@@ -0,0 +1,741 @@
|
||||
# class MapGen
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## methods
|
||||
---
|
||||
|
||||
### MapGen.new
|
||||
---
|
||||
```lua
|
||||
function MapGen.new(def: MapGenDef {
|
||||
nodes = table<string,string>,
|
||||
}) -> MapGen {
|
||||
layersByName = table<string,MapGen.Layer>,
|
||||
layersList = MapGen.Layer[],
|
||||
staticsByName = table<string,MapGen.StaticLayer>,
|
||||
staticsList = MapGen.StaticLayer[],
|
||||
layersNoisesInitialized = boolean,
|
||||
cavernsNoiseInitialized = boolean,
|
||||
isRunning = boolean,
|
||||
nodeIDs = table<string,number>,
|
||||
new = function,
|
||||
getLayerByHeight = function,
|
||||
getStaticByHeight = function,
|
||||
registerLayer = function,
|
||||
registerLayerNoiseColor = function,
|
||||
registerStaticLayer = function,
|
||||
registerPeak = function,
|
||||
register2DPeak = function,
|
||||
register2DPeaks = function,
|
||||
register2DPeaksFromFile = function,
|
||||
registerBiome = function,
|
||||
registerCavern = function,
|
||||
initLayersTriangultaion = function,
|
||||
initLayersNoises = function,
|
||||
initBiomesDiagram = function,
|
||||
initCavernsNoise = function,
|
||||
getNoises2dValue = function,
|
||||
onMapGenerated = function,
|
||||
run = function,
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.getLayerByHeight
|
||||
---
|
||||
```lua
|
||||
function MapGen.getLayerByHeight(yPos: number) -> MapGen.Layer?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Determines which layer a node belongs to based on its height coordinate.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.getStaticByHeight
|
||||
---
|
||||
```lua
|
||||
function MapGen.getStaticByHeight(yPos: number) -> MapGen.StaticLayer?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Determines which statics layer a node belongs to based on its height coordinate.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.registerLayer
|
||||
---
|
||||
```lua
|
||||
function MapGen.registerLayer(
|
||||
name: string,
|
||||
def: MapGen.LayerDef {
|
||||
minY = number,
|
||||
maxY = number,
|
||||
minTemp = number,
|
||||
maxTemp = number,
|
||||
minHumidity = number,
|
||||
maxHumidity = number,
|
||||
waterLevel = number?,
|
||||
calcTemp = (fun(self: MapGen.Layer, value: number, height: number) -> number)?,
|
||||
calcHumidity = (fun(self: MapGen.Layer, value: number, height: number) -> number)?,
|
||||
biomesGorizontalScattering = number?,
|
||||
biomesVerticalScattering = number?,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
@param `name` - The name that will be assigned to the layer. The name must be unique for each layer.
|
||||
|
||||
@param `def` - Layer description table, see details `MapGen.LayerDef`.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Mark the world area between two heights as a `MapGen.Layer`.
|
||||
|
||||
Note: layers must not overlap.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.registerLayerNoiseColor
|
||||
---
|
||||
```lua
|
||||
function MapGen.registerLayerNoiseColor(
|
||||
layerName: string,
|
||||
category: MapGen.Layer.Category,
|
||||
color: ColorString,
|
||||
noiseParams: NoiseParams
|
||||
) -> nil
|
||||
```
|
||||
@param `layerName` - The name of the layer for which the color will be registered.
|
||||
|
||||
@param `category` - Category indicating what will be generated by noise.
|
||||
|
||||
@param `color` - Noise color. Must be unique.
|
||||
|
||||
@param `noiseParams` - Fractal noise parameters.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Register the color and the noise parameters that correspond to it.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.registerStaticLayer
|
||||
---
|
||||
```lua
|
||||
function MapGen.registerStaticLayer(
|
||||
name: string,
|
||||
def: MapGen.StaticLayerDef {
|
||||
minY = number,
|
||||
maxY = number,
|
||||
staticNode = string,
|
||||
generateStaticNode = generateFunc,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
@param `name` - The name that will be assigned to the static layer. The name must be unique for each layer.
|
||||
|
||||
@param `def` - Static layer description table, see details `MapGen.StaticLayerDef`.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Mark the world area between two heights as a `MapGen.StaticLayer`.
|
||||
|
||||
Note: layers must not overlap.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.registerPeak
|
||||
---
|
||||
```lua
|
||||
function MapGen.registerPeak(
|
||||
layerName: string,
|
||||
category: MapGen.Layer.Category,
|
||||
def: MapGen.PeakDef {
|
||||
pos = vector,
|
||||
color = ColorString,
|
||||
groups = table<string,number>?,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
@param `layerName` - The name of the layer in which the new peak will be included.
|
||||
|
||||
@param `category` - Category indicating what will be generated by peak.
|
||||
|
||||
@param `def` - Peak description table, see details `MapGen.PeakDef`.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Mark a world point as `MapGen.Peak` and assign it a specific color that will affect the generation.
|
||||
|
||||
Note: The peaks shouldn't overlap. This won't cause any errors, but it might ruin the generation.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.register2DPeak
|
||||
---
|
||||
```lua
|
||||
function MapGen.register2DPeak(
|
||||
layerName: string,
|
||||
category: MapGen.Layer.Category,
|
||||
def: MapGen.PeakDef {
|
||||
pos = vector,
|
||||
color = ColorString,
|
||||
groups = table<string,number>?,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
@param `layerName` - The name of the layer in which the new peak will be included.
|
||||
|
||||
@param `category` - Category indicating what will be generated by peak.
|
||||
|
||||
@param `def` - Peak description table, see details `MapGen.PeakDef`.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Mark a world point as `MapGen.Peak` and assign it a specific color that will affect the generation.
|
||||
The Y coordinate will be forced to zero, and the `is2d` group will be added to the groups field.
|
||||
|
||||
Note: The peaks shouldn't overlap. This won't cause any errors, but it might ruin the generation.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.register2DPeaks
|
||||
---
|
||||
```lua
|
||||
function MapGen.register2DPeaks(
|
||||
layerName: string,
|
||||
category: MapGen.Layer.Category,
|
||||
defs: MapGen.PeakDef[]
|
||||
) -> nil
|
||||
```
|
||||
@param `layerName` - The name of the layer in which the new peaks will be included.
|
||||
|
||||
@param `category` - Category indicating what will be generated by peaks.
|
||||
|
||||
@param `defs` - Peaks description table, see details `MapGen.PeakDef`.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Mark the world points as `MapGen.Peak` and assign them all a specific noise that will affect generation.
|
||||
The Y coordinate will be forced to zero, and the `is2d` group will be added to the groups field.
|
||||
|
||||
Note: The peaks shouldn't overlap. This won't cause any errors, but it might ruin the generation.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.register2DPeaksFromFile
|
||||
---
|
||||
```lua
|
||||
function MapGen.register2DPeaksFromFile(
|
||||
layerName: string,
|
||||
map: string,
|
||||
scale: number,
|
||||
zeroPos: Position2d,
|
||||
category: MapGen.Layer.Category,
|
||||
groups: table<string,number>?
|
||||
) -> nil
|
||||
```
|
||||
@param `layerName` - The name of the layer in which the new peaks will be included.
|
||||
|
||||
@param `map` - The name of the image from which the peaks will be extracted. It should be located in the `<mod_name>/textures/maps` folder and have the following format `<image_name>.ff`
|
||||
|
||||
@param `scale` - Multiplier of how many blocks (nodes) will be between image pixels. It is not recommended to set the value below 50 for performance reasons.
|
||||
|
||||
@param `zeroPos` - The position in pixels where the zero world coordinate will be in the image.
|
||||
|
||||
@param `category` - Category indicating what will be generated by peaks.
|
||||
|
||||
@param `groups` - Groups that will be added to all peaks.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Extract the `MapGen.Peak` from the image and assign them all a specific color that will affect the generation.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.registerBiome
|
||||
---
|
||||
```lua
|
||||
function MapGen.registerBiome(
|
||||
layerName: string,
|
||||
biomeName: string,
|
||||
def: MapGen.BiomeDef {
|
||||
tempPoint = number,
|
||||
humidityPoint = number,
|
||||
minY = number,
|
||||
maxY = number,
|
||||
groundNodes = MapGen.Biome.GroundNodes,
|
||||
soilHeight = number,
|
||||
generateAir = generateFunc?,
|
||||
generateCavernAir = generateFunc?,
|
||||
generateWater = generateFunc?,
|
||||
generateRock = generateFunc?,
|
||||
generateTurf = generateFunc?,
|
||||
generateSoil = generateFunc?,
|
||||
generateBottom = generateFunc?,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
@param `layerName` - The name of the layer in which the new biome will be included.
|
||||
|
||||
@param `biomeName` - The name to be assigned to the biome. The name must be unique for each biome.
|
||||
|
||||
@param `def` - Biome description table, see details `MapGen.BiomeDef`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Mark a point on the biomes diagram and constrain the world area by height to mark it as `MapGen.Biome`.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.registerCavern
|
||||
---
|
||||
```lua
|
||||
function MapGen.registerCavern(
|
||||
layerName: string,
|
||||
cavernName: string,
|
||||
def: MapGen.CavernDef {
|
||||
minY = number,
|
||||
maxY = number,
|
||||
noiseParams = NoiseParams,
|
||||
smoothDistance = number,
|
||||
threshold = number?,
|
||||
groups = table<string,number>?,
|
||||
}
|
||||
) -> nil
|
||||
```
|
||||
@param `layerName` - The name of the layer in which the new cavern will be included.
|
||||
|
||||
@param `cavernName` - The name to be assigned to the cavern. The name must be unique for each cavern.
|
||||
|
||||
@param `def` - Cavern description table, see details `MapGen.CavernDef`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Mark the world area between two heights as a `MapGen.Cavern` and assign the noise that the cave will be generated from.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.initLayersTriangultaion
|
||||
---
|
||||
```lua
|
||||
function MapGen.initLayersTriangultaion() -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Divide all layers into triangles whose vertices are the `Mapgen.Peak` belonging to these layers.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.initLayersNoises
|
||||
---
|
||||
```lua
|
||||
function MapGen.initLayersNoises() -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Initialize all layer noises. This should be called after the map object is loaded.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.initBiomesDiagram
|
||||
---
|
||||
```lua
|
||||
function MapGen.initBiomesDiagram() -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Initialization of the biome diagram using the Voronoi method.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.initCavernsNoise
|
||||
---
|
||||
```lua
|
||||
function MapGen.initCavernsNoise() -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Initialize caverns's noises. This should be called after the map object is loaded.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.getNoises2dValue
|
||||
---
|
||||
```lua
|
||||
function MapGen.getNoises2dValue(
|
||||
category: MapGen.Layer.Category,
|
||||
layer: MapGen.Layer {
|
||||
name = string,
|
||||
minY = integer,
|
||||
maxY = integer,
|
||||
minTemp = integer,
|
||||
maxTemp = integer,
|
||||
minHumidity = integer,
|
||||
maxHumidity = integer,
|
||||
waterLevel = integer,
|
||||
peaksList = { humidity: MapGen.Peak[], landscape: MapGen.Peak[], temp: MapGen.Peak[] },
|
||||
noisesByColor = { humidity: table<ColorString,ValueNoise>, landscape: table<ColorString,ValueNoise>, temp: table<ColorString,ValueNoise> },
|
||||
noisesParamsByColor = { humidity: table<ColorString,NoiseParams>, landscape: table<ColorString,NoiseParams>, temp: table<ColorString,NoiseParams> },
|
||||
biomesByName = table<string,MapGen.Biome>,
|
||||
biomesList = MapGen.Biome[],
|
||||
biomesDiagram = table,
|
||||
biomesGorizontalScattering = integer,
|
||||
biomesVerticalScattering = integer,
|
||||
cavernsByName = table<string,MapGen.Cavern>,
|
||||
cavernsList = MapGen.Cavern[],
|
||||
trianglesList = { humidity: MapGen.Triangle[], landscape: MapGen.Triangle[], temp: MapGen.Triangle[] },
|
||||
tetrahedronsList = MapGen.Tetrahedron[],
|
||||
calcTemp = function,
|
||||
calcHumidity = function,
|
||||
new = function,
|
||||
addPeak = function,
|
||||
addNoiseParamsColor = function,
|
||||
getNoiseByColor = function,
|
||||
addBiome = function,
|
||||
addCavern = function,
|
||||
initNoises = function,
|
||||
initBiomesDiagram = function,
|
||||
},
|
||||
x: integer,
|
||||
y: integer,
|
||||
z: integer
|
||||
) -> number?
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Calculates a smoothed 2D noise value based on a preliminary space partitioning.
|
||||
|
||||
Returns `nil` if the point is not included in any triangle.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.onMapGenerated
|
||||
---
|
||||
```lua
|
||||
function MapGen.onMapGenerated(
|
||||
voxelManip: VoxelManip,
|
||||
minPos: Position,
|
||||
maxPos: Position,
|
||||
blockseed: number
|
||||
) -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Chunk generation handler.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.run
|
||||
---
|
||||
```lua
|
||||
function MapGen.run() -> nil
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Run world generation through this mapgen object
|
||||
|
||||
Note: only one instance of a `MapGen` class can be running.
|
||||
|
||||
**FOR MAPGEN ENVIRONMENT ONLY**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### MapGen.layersByName
|
||||
---
|
||||
```lua
|
||||
MapGen.layersByName : table<string,MapGen.Layer>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.layersList
|
||||
---
|
||||
```lua
|
||||
MapGen.layersList : MapGen.Layer[]
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.staticsByName
|
||||
---
|
||||
```lua
|
||||
MapGen.staticsByName : table<string,MapGen.StaticLayer>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.staticsList
|
||||
---
|
||||
```lua
|
||||
MapGen.staticsList : MapGen.StaticLayer[]
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.layersNoisesInitialized
|
||||
---
|
||||
```lua
|
||||
MapGen.layersNoisesInitialized : boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
Is the fractal noise of the layer initialized? This is necessary for a one-time noise initialization.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.cavernsNoiseInitialized
|
||||
---
|
||||
```lua
|
||||
MapGen.cavernsNoiseInitialized : boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
Is the fractal noise of the caverns initialized? This is necessary for a one-time noise initialization.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.isRunning
|
||||
---
|
||||
```lua
|
||||
MapGen.isRunning : boolean
|
||||
```
|
||||
|
||||
|
||||
|
||||
A static field that guarantees that only one instance of the `MapGen` class will work.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### MapGen.nodeIDs
|
||||
---
|
||||
```lua
|
||||
MapGen.nodeIDs : table<string,number>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
39
docs/docs/types/MapGenDef.md
Normal file
39
docs/docs/types/MapGenDef.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# class MapGenDef
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Definition table for the `MapGen`.
|
||||
|
||||
**Only for EmmyLua.**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
## fields
|
||||
---
|
||||
|
||||
### MapGenDef.nodes
|
||||
---
|
||||
```lua
|
||||
MapGenDef.nodes : table<string,string>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
12
docs/docs/types/generateFunc.md
Normal file
12
docs/docs/types/generateFunc.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# alias generateFunc
|
||||
---
|
||||
|
||||
|
||||
|
||||
```lua
|
||||
(alias) generateFunc = fun(self, mapGenerator: MapGen, data: number[], index: number, x: number, y: number, z: number)
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
80
docs/mkdocs.yml
Normal file
80
docs/mkdocs.yml
Normal file
@@ -0,0 +1,80 @@
|
||||
|
||||
site_name: Docs
|
||||
|
||||
|
||||
theme:
|
||||
name: material
|
||||
font:
|
||||
text: Roboto
|
||||
code: Roboto Mono
|
||||
search: true
|
||||
features:
|
||||
- quick-links
|
||||
- navigation
|
||||
- search
|
||||
- toc
|
||||
- fullscreen
|
||||
- bookmarks
|
||||
- tabs
|
||||
- code
|
||||
- edit-on-github
|
||||
- language-selector
|
||||
- code
|
||||
- cover
|
||||
- footer
|
||||
- social-share
|
||||
- theme-switcher
|
||||
nav:
|
||||
- Home: index.md
|
||||
|
||||
- Types:
|
||||
- alias Category : types/MapGen.Layer.Category.md
|
||||
- alias CircumCircleEnum : types/MapGen.Triangle.CircumCircleEnum.md
|
||||
- alias ColoredDotsTable : types/ColoredDotsTable.md
|
||||
- alias Neighbours : types/MapGen.Triangle.Neighbours.md
|
||||
- alias PastCalcNoiseValue : types/MapGen.PastCalcNoiseValue.md
|
||||
- alias generateFunc : types/generateFunc.md
|
||||
- class Biome : types/MapGen.Biome.md
|
||||
- class BiomeDef : types/MapGen.BiomeDef.md
|
||||
- class Cavern : types/MapGen.Cavern.md
|
||||
- class CavernDef : types/MapGen.CavernDef.md
|
||||
- class Decoration : types/MapGen.Decoration.md
|
||||
- class Edge : types/MapGen.Triangulation.Edge.md
|
||||
- class FakePeak : types/MapGen.Triangulation.FakePeak.md
|
||||
- class GroundNodes : types/MapGen.Biome.GroundNodes.md
|
||||
- class GroundNodesIDs : types/MapGen.Biome.GroundNodesIDs.md
|
||||
- class Layer : types/MapGen.Layer.md
|
||||
- class LayerDef : types/MapGen.LayerDef.md
|
||||
- class MapGen : types/MapGen.md
|
||||
- class MapGenDef : types/MapGenDef.md
|
||||
- class Peak : types/MapGen.Peak.md
|
||||
- class PeakDef : types/MapGen.PeakDef.md
|
||||
- class StaticLayer : types/MapGen.StaticLayer.md
|
||||
- class StaticLayerDef : types/MapGen.StaticLayerDef.md
|
||||
- class Tetrahedron : types/MapGen.Tetrahedron.md
|
||||
- class Triangle : types/MapGen.Triangle.md
|
||||
- class Triangulation : types/MapGen.Triangulation.md
|
||||
|
||||
|
||||
|
||||
- Modules:
|
||||
- MapGen : modules/MapGen.md
|
||||
- MapGen.Biome : modules/MapGen.Biome.md
|
||||
- MapGen.Biome.GroundNodes : modules/MapGen.Biome.GroundNodes.md
|
||||
- MapGen.Biome.GroundNodesIds : modules/MapGen.Biome.GroundNodesIds.md
|
||||
- MapGen.Cavern : modules/MapGen.Cavern.md
|
||||
- MapGen.Decoration : modules/MapGen.Decoration.md
|
||||
- MapGen.Layer : modules/MapGen.Layer.md
|
||||
- MapGen.Peak : modules/MapGen.Peak.md
|
||||
- MapGen.StaticLayer : modules/MapGen.StaticLayer.md
|
||||
- MapGen.Tetrahedron : modules/MapGen.Tetrahedron.md
|
||||
- MapGen.Triangle : modules/MapGen.Triangle.md
|
||||
- MapGen.Triangulation : modules/MapGen.Triangulation.md
|
||||
- MapGen.Triangulation.Edge : modules/MapGen.Triangulation.Edge.md
|
||||
- MapGen.Triangulation.FakePeak : modules/MapGen.Triangulation.FakePeak.md
|
||||
- MapGen.ff2luat : modules/MapGen.ff2luat.md
|
||||
|
||||
|
||||
|
||||
extra:
|
||||
footer: ""
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 7.3 MiB After Width: | Height: | Size: 2.1 MiB |
@@ -1,4 +0,0 @@
|
||||
local modInfo = Mod.getInfo('smc__core__base_processing_station')
|
||||
local require = modInfo.require
|
||||
|
||||
return require('BaseProcessingStation')
|
||||
@@ -1,2 +0,0 @@
|
||||
name = smc__core__base_processing_station
|
||||
depends = smc__core__craft_system, smc__core__node
|
||||
@@ -1,100 +0,0 @@
|
||||
local TICKRATE = 1
|
||||
|
||||
local assert = assert
|
||||
local coreGetMeta, coreGetTimer, coreSwapNode = core.get_meta, core.get_node_timer, core.swap_node
|
||||
|
||||
local CraftSystem = Smc.requireCraftSystem()
|
||||
local PlayerInventoryUI = Smc.requirePlayerInventoryUI()
|
||||
|
||||
---An abstract class representing nodes that implement crafting of the `processing` type.
|
||||
---@class BaseProcessingStation : Class, NodeSuperClass
|
||||
---@field craftType CraftSystem.ProcessingCraftType
|
||||
---@field handler CraftSystem.ProcessingCraftHandler
|
||||
---@field tab PlayerInventoryUI.getTabFunc
|
||||
---@field nodeName string?
|
||||
---@field activeNodeName string?
|
||||
local BaseProcessingStation = Class:extend({})
|
||||
|
||||
---Definition table for the `BaseProcessingStation`.
|
||||
---
|
||||
---**Only for EmmyLua.**
|
||||
---@class BaseProcessingStationDef
|
||||
---@field craftType CraftSystem.ProcessingCraftType
|
||||
---@field tab PlayerInventoryUI.getTabFunc
|
||||
|
||||
---@alias BaseProcessingStation.NodesDefinition {settings:Node.Settings, activeSettings:Node.Settings?, callbacks:Node.Callbacks?}
|
||||
|
||||
---@param def BaseProcessingStationDef
|
||||
---@param nodesDef BaseProcessingStation.NodesDefinition?
|
||||
function BaseProcessingStation:new(def, nodesDef)
|
||||
local handler = CraftSystem:getProcessingCraftHandler(def.craftType)
|
||||
|
||||
---@type BaseProcessingStation
|
||||
local instance = self:getInstance({})
|
||||
instance.craftType = def.craftType
|
||||
instance.handler = handler
|
||||
instance.tab = def.tab
|
||||
|
||||
return instance
|
||||
end
|
||||
|
||||
---A wrapper around `core.get_meta()` for convenience
|
||||
---and returning the correct `MetaDataRef` type.
|
||||
---@static
|
||||
---@param pos MapVector
|
||||
---@return MetaDataRef
|
||||
function BaseProcessingStation:getMeta(pos)
|
||||
return coreGetMeta(pos)
|
||||
end
|
||||
|
||||
---Opens the player's inventory, adding the node tab described in `self.tab`.
|
||||
---@param pos MapVector
|
||||
---@param player Player
|
||||
function BaseProcessingStation:showForm(pos, player)
|
||||
local playerName = player:get_player_name()
|
||||
|
||||
PlayerInventoryUI:addActiveNodeForm(pos, playerName)
|
||||
PlayerInventoryUI:setContex(playerName, 'left_tab_name', 'node_tab')
|
||||
PlayerInventoryUI:setContex(playerName, 'node_tab_pos', pos)
|
||||
PlayerInventoryUI:setContex(playerName, 'node_tab', self.tab)
|
||||
|
||||
PlayerInventoryUI:showForm(playerName)
|
||||
end
|
||||
|
||||
---Starts the station timer only if it is not running.
|
||||
---
|
||||
---Returns `true` if the timer has been started.
|
||||
---@static
|
||||
---@param pos MapVector
|
||||
---@param timeout number? If is `nil`, the global `TICKRATE` setting will be used.
|
||||
---@return boolean
|
||||
function BaseProcessingStation:startTimer(pos, timeout)
|
||||
local timer = coreGetTimer(pos)
|
||||
|
||||
if not timer:is_started() then
|
||||
timer:start(timeout or TICKRATE)
|
||||
return true
|
||||
end
|
||||
|
||||
return false
|
||||
end
|
||||
|
||||
---Replaces the node with active or inactive depending on the status of the process.
|
||||
---
|
||||
---If an active node is not specified for a station,
|
||||
---then no replacement will occur regardless of the status of the process.
|
||||
---@param isProcessing boolean The stations process status. If `true`, the process is running.
|
||||
---@param pos MapVector
|
||||
function BaseProcessingStation:swapNode(isProcessing, pos)
|
||||
assert(self.nodeName ~= nil)
|
||||
|
||||
if self.activeNodeName ~= nil then
|
||||
if isProcessing then
|
||||
coreSwapNode(pos, {name = self.activeNodeName})
|
||||
else
|
||||
coreSwapNode(pos, {name = self.nodeName})
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
return BaseProcessingStation
|
||||
@@ -1,4 +0,0 @@
|
||||
local modInfo = Mod.getInfo('smc__core__base_ui')
|
||||
local require = modInfo.require
|
||||
|
||||
return require('BaseUI')
|
||||
@@ -1,2 +0,0 @@
|
||||
name = smc__core__base_ui
|
||||
depends = smc__system__system_loader
|
||||
@@ -1,135 +0,0 @@
|
||||
local getInstance = Class.getInstance
|
||||
|
||||
---@class BaseUI
|
||||
---Context for transferring data between displaying
|
||||
---the form spec to the player and handling callbacks.
|
||||
---@field name string
|
||||
---@field getFormSpecString fun(self:BaseUI,playerName:string,...):string
|
||||
---@field contex table<string, table>
|
||||
local BaseUI = {
|
||||
contex = {}
|
||||
}
|
||||
|
||||
---@param name string The name of the formspec that will be shown to the player. It is recommended that the name be unique.
|
||||
---@param getFormSpecString fun(self:BaseUI,playerName:string,...):string
|
||||
---@param clearContex boolean? Whether to clear the context stored for a player when that player closes the form. Default `true`.
|
||||
function BaseUI:new(name, getFormSpecString, clearContex)
|
||||
if clearContex == nil then
|
||||
clearContex = true
|
||||
end
|
||||
|
||||
---@type BaseUI
|
||||
local instance = getInstance(self, {})
|
||||
instance.name = name
|
||||
instance.getFormSpecString = getFormSpecString
|
||||
|
||||
if clearContex then
|
||||
-- Ensure that when the form is closed, the context is cleared.
|
||||
instance:registerOnFormQuit(function(player)
|
||||
instance:clearContex(player)
|
||||
end)
|
||||
end
|
||||
|
||||
instance:registerOnFormQuit(function(player)
|
||||
Smc.clearActiveFormspec(player:get_player_name())
|
||||
end)
|
||||
|
||||
return instance
|
||||
end
|
||||
|
||||
---Set a value for a specific key.
|
||||
---Recommended for use where `core.show_formspec` is used.
|
||||
---
|
||||
---In the future, the key value can be obtained in the formspec callback.
|
||||
---@param player string|Player Player as an object (entity) or his name
|
||||
---@param key string
|
||||
---@param value any
|
||||
function BaseUI:setContex(player, key, value)
|
||||
if type(player) ~= 'string' then
|
||||
player = player:get_player_name()
|
||||
end
|
||||
|
||||
local contex = self.contex[player]
|
||||
|
||||
if contex == nil then
|
||||
self.contex[player] = {[key]=value}
|
||||
else
|
||||
contex[key] = value
|
||||
end
|
||||
end
|
||||
|
||||
---Get the value of a specific key.
|
||||
---Recommended for use in a formspec callback.
|
||||
---@param player string|Player Player as an object (entity) or his name
|
||||
---@param key string
|
||||
---@return any?
|
||||
function BaseUI:getContex(player, key)
|
||||
if type(player) ~= 'string' then
|
||||
player = player:get_player_name()
|
||||
end
|
||||
|
||||
local contex = self.contex[player] or {}
|
||||
return contex[key]
|
||||
end
|
||||
|
||||
---Clear saved context data for a player.
|
||||
---Recommended for use when closing formspec.
|
||||
---@param player string|Player Player as an object (entity) or his name
|
||||
function BaseUI:clearContex(player)
|
||||
if type(player) ~= 'string' then
|
||||
player = player:get_player_name()
|
||||
end
|
||||
|
||||
self.contex[player] = {}
|
||||
end
|
||||
|
||||
---Register a callback for a specific player action in FormSpec.
|
||||
---
|
||||
---The callback is guaranteed to be called only for the specified field.
|
||||
---@param fieldName string the name of the field for which the callback will be called.
|
||||
---@param callback fun(player:Player, fieldName:string, fieldValue:any) Callback to handle the action. Parameters:
|
||||
--- * `player` - the player who performed the action.
|
||||
--- * `fieldName` - the name of the field on which the callback is called.
|
||||
--- * `fieldValue` - the field value that is passed in the `fields` table.
|
||||
function BaseUI:registerOnFormFieldAction(fieldName, callback)
|
||||
Smc.registerOnFormFieldAction(self.name, fieldName, callback)
|
||||
end
|
||||
|
||||
---Register a callback function to close the FormSpec.
|
||||
---
|
||||
---The callback is guaranteed to be called only for the specified form.
|
||||
---@param callback fun(player:Player) Callback to handle the close. Parameters:
|
||||
--- * `player` - the player who closed the form.
|
||||
function BaseUI:registerOnFormQuit(callback)
|
||||
Smc.registerOnFormQuit(self.name, callback)
|
||||
end
|
||||
|
||||
---Register a callback for a specific player action in FormSpec.
|
||||
---
|
||||
---The callback function is guaranteed to be called only for the specified form and
|
||||
---for the field whose name matches the pattern.
|
||||
---@param fieldNamePattern string the name pattern of the field for which the callback will be called.
|
||||
---@param callback fun(player:Player, fieldName:string, fieldValue:any) Callback to handle the action. Parameters:
|
||||
--- * `player` - the player who performed the action.
|
||||
--- * `fieldName` - the name of the field on which the callback is called (will match the pattern).
|
||||
--- * `fieldValue` - the field value that is passed in the `fields` table.
|
||||
function BaseUI:registerOnFormFieldActionMatch( fieldNamePattern, callback)
|
||||
Smc.registerOnFormFieldActionMatch(self.name, fieldNamePattern, callback)
|
||||
end
|
||||
|
||||
---Shows the player the FormSpec registered by the instance of this UI.
|
||||
---@param playerName string
|
||||
function BaseUI:showForm(playerName, ...)
|
||||
core.show_formspec(playerName, self.name, self:getFormSpecString(playerName, ...))
|
||||
Smc.setActiveFormspec(playerName, self.name)
|
||||
end
|
||||
|
||||
---Close the player the FormSpec registered by the instance of this UI.
|
||||
---@param playerName string
|
||||
function BaseUI:closeForm(playerName)
|
||||
core.close_formspec(playerName, self.name)
|
||||
Smc.clearActiveFormspec(playerName)
|
||||
end
|
||||
|
||||
|
||||
return BaseUI
|
||||
@@ -2,34 +2,38 @@
|
||||
local Control = {}
|
||||
|
||||
-- control.on_press
|
||||
Events.registerEvent('control.on_press')
|
||||
|
||||
---@param callbackFunc fun(player:Player, controlName:string)
|
||||
function Control.subcribeOnPress(callbackFunc)
|
||||
Events:subscribe('control.on_press', callbackFunc)
|
||||
Events.subscribe('control.on_press', callbackFunc)
|
||||
end
|
||||
|
||||
|
||||
-- control.on_release
|
||||
Events.registerEvent('control.on_release')
|
||||
|
||||
---@param callbackFunc fun(player:Player, controlName:string, holdTime:number)
|
||||
function Control.subcribeOnRelease(callbackFunc)
|
||||
Events:subscribe('control.on_release', callbackFunc)
|
||||
Events.subscribe('control.on_release', callbackFunc)
|
||||
end
|
||||
|
||||
|
||||
-- control.on_hold
|
||||
Events.registerEvent('control.on_hold')
|
||||
|
||||
---@param callbackFunc fun(player:Player, controlName:string, holdTime:number, dtime:number)
|
||||
function Control.subcribeOnHold(callbackFunc)
|
||||
Events:subscribe('control.on_hold', callbackFunc)
|
||||
Events.subscribe('control.on_hold', callbackFunc)
|
||||
end
|
||||
|
||||
|
||||
-- control.on_wield_change
|
||||
Events.registerEvent('control.on_wield_change')
|
||||
|
||||
---@param callbackFunc fun(player:Player, player_wield_index:number, player_last_wield_index:number)
|
||||
function Control.subcribeOnWieldChange(callbackFunc)
|
||||
Events:subscribe('control.on_wield_change', callbackFunc)
|
||||
Events.subscribe('control.on_wield_change', callbackFunc)
|
||||
end
|
||||
|
||||
|
||||
@@ -107,19 +111,19 @@ Smc.registerGlobalStepForEachPlayer(0, function(deltaTime, player)
|
||||
|
||||
-- on_press
|
||||
if not lastPressed and nowPressed then
|
||||
Events:call('control.on_press', key)
|
||||
Events.call('control.on_press', key)
|
||||
|
||||
controlTimer[key] = 0
|
||||
|
||||
-- on_release
|
||||
elseif lastPressed and not nowPressed then
|
||||
Events:call('control.on_release', key, controlTimer[key])
|
||||
Events.call('control.on_release', key, controlTimer[key])
|
||||
|
||||
controlTimer[key] = 0
|
||||
|
||||
-- on_hold
|
||||
elseif lastPressed and nowPressed then
|
||||
Events:call('control.on_hold', key, controlTimer[key], deltaTime)
|
||||
Events.call('control.on_hold', key, controlTimer[key], deltaTime)
|
||||
|
||||
controlTimer[key] = controlTimer[key] + deltaTime
|
||||
end
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
local modInfo = Mod.getInfo('smc__core__craft_system')
|
||||
local require = modInfo.require
|
||||
|
||||
return require('CraftSystem')
|
||||
return require('CraftSystem')
|
||||
@@ -1,2 +1,2 @@
|
||||
name = smc__core__craft_system
|
||||
depends = smc__system__system_loader, smc__core__creature
|
||||
depends = smc__system__system_loader
|
||||
|
||||
@@ -1,234 +1,117 @@
|
||||
local tableJoin = table.join
|
||||
local HASH_SPLITTER = '&'
|
||||
|
||||
local modInfo = Mod.getInfo('smc__core__craft_system')
|
||||
local require = modInfo.require
|
||||
|
||||
---@type CraftSystem.PrimitiveCraftHandler
|
||||
local PrimitiveCraftHandler = require('CraftSystem.PrimitiveCraftHandler')
|
||||
---@type CraftSystem.ImmersiveCraftHandler
|
||||
local ImmersiveCraftHandler= require('CraftSystem.ImmersiveCraftHandler')
|
||||
---@type CraftSystem.ProcessingCraftHandler
|
||||
local ProcessingCraftHandler= require('CraftSystem.ProcessingCraftHandler')
|
||||
|
||||
---@alias CraftSystem.CraftGroup string
|
||||
---@alias CraftSystem.CraftRecipe ItemStackString[]
|
||||
---@alias CraftSystem.shapelessCraftsList table<CraftSystem.Craft.Group, table<string, CraftSystem.ShapelessCraft[]>>
|
||||
---@alias CraftSystem.processualCraftsList table<CraftSystem.Craft.Group, table<string, CraftSystem.ProcessualCraft[]>>
|
||||
|
||||
---@class CraftSystem
|
||||
---@field PrimitiveCraftHandlers table<string, CraftSystem.PrimitiveCraftHandler>
|
||||
---@field ImmersiveCraftHandlers table<string, CraftSystem.ImmersiveCraftHandler>
|
||||
---@field ProcessingCraftHandlers table<string, CraftSystem.ProcessingCraftHandler>
|
||||
---@field shapelessCraftsList CraftSystem.shapelessCraftsList
|
||||
---@field processualCraftsList CraftSystem.processualCraftsList
|
||||
local CraftSystem = {
|
||||
PrimitiveCraftHandlers = {},
|
||||
ImmersiveCraftHandlers = {},
|
||||
ProcessingCraftHandlers = {}
|
||||
shapelessCraftsList = {},
|
||||
processualCraftsList = {},
|
||||
}
|
||||
|
||||
---@alias CraftSystem.Craft.Type
|
||||
---|'shapeless'
|
||||
---|'processual'
|
||||
---@alias CraftSystem.Craft.Group string
|
||||
---@alias CraftSystem.Craft.Recipe string[]
|
||||
|
||||
---@alias shapelessCraftFunc fun(self:CraftSystem.ShapelessCraft, input:ItemStack[], workbenchMeta:NodeMetaRef?):boolean
|
||||
---@alias processualCraftFunc fun(self:CraftSystem.ProcessualCraft, input:ItemStack[], workbenchMeta:NodeMetaRef?, processTime:number):boolean
|
||||
|
||||
--- Craft Types ---
|
||||
---@class CraftSystem.BaseCraft
|
||||
---@field type CraftSystem.Craft.Type
|
||||
---@field group CraftSystem.Craft.Group
|
||||
---@field output string
|
||||
---@field recipe CraftSystem.Craft.Recipe
|
||||
---@field return table? TODO: доделать тут тип
|
||||
---@field craftFunc (fun(self, ...):boolean)?
|
||||
|
||||
---@alias CraftSystem.BaseCraftType 'primitive'|'immersive'|'processing'
|
||||
---@alias CraftSystem.PrimitiveCraftType 'inside_player_inventory'
|
||||
---@alias CraftSystem.ImmersiveCraftType 'workbench' -- DEBUG
|
||||
---@alias CraftSystem.ProcessingCraftType 'test' -- DEBUG
|
||||
---@alias CraftSystem.CraftType CraftSystem.PrimitiveCraftType|CraftSystem.ImmersiveCraftType|CraftSystem.ProcessingCraftType
|
||||
---@class CraftSystem.ShapelessCraft : CraftSystem.BaseCraft
|
||||
---@field craftFunc shapelessCraftFunc?
|
||||
|
||||
---@param type CraftSystem.PrimitiveCraftType
|
||||
---@param def CraftSystem.PrimitiveCraftHandlerDef
|
||||
local function registerPrimitiveCraftType(type, def)
|
||||
assert(CraftSystem.PrimitiveCraftHandlers[type] == nil, ('A primitive craft type `%s` already exists.'):format(type))
|
||||
---@class CraftSystem.ProcessualCraft : CraftSystem.BaseCraft
|
||||
---@field processTime number
|
||||
---@field craftFunc processualCraftFunc?
|
||||
|
||||
local handler = PrimitiveCraftHandler:new('primitive', type, def)
|
||||
CraftSystem.PrimitiveCraftHandlers[type] = handler
|
||||
end
|
||||
---@param type CraftSystem.Craft.Type
|
||||
---@return CraftSystem.shapelessCraftsList|CraftSystem.processualCraftsList
|
||||
local function getCraftList(type)
|
||||
local craftList
|
||||
|
||||
---@param type CraftSystem.ImmersiveCraftType
|
||||
---@param def CraftSystem.ImmersiveCraftHandlerDef
|
||||
local function registerImmersiveCraftType(type, def)
|
||||
assert(CraftSystem.ImmersiveCraftHandlers[type] == nil, ('A immersive craft type `%s` already exists.'):format(type))
|
||||
|
||||
local handler = ImmersiveCraftHandler:new('immersive', type, def)
|
||||
CraftSystem.ImmersiveCraftHandlers[type] = handler
|
||||
end
|
||||
|
||||
---@param type CraftSystem.ProcessingCraftType
|
||||
---@param def CraftSystem.ProcessingCraftHandlerDef
|
||||
local function registerProcessingCraftType(type, def)
|
||||
assert(CraftSystem.ProcessingCraftHandlers[type] == nil, ('A processing craft type `%s` already exists.'):format(type))
|
||||
|
||||
local handler = ProcessingCraftHandler:new('processing', type, def)
|
||||
CraftSystem.ProcessingCraftHandlers[type] = handler
|
||||
end
|
||||
|
||||
---@param type CraftSystem.PrimitiveCraftType
|
||||
---@return CraftSystem.PrimitiveCraftHandler
|
||||
function CraftSystem:getPrimitiveCraftHandler(type)
|
||||
local handler = self.PrimitiveCraftHandlers[type]
|
||||
assert(handler ~= nil)
|
||||
|
||||
return handler
|
||||
end
|
||||
|
||||
---@param type CraftSystem.ImmersiveCraftType
|
||||
---@return CraftSystem.ImmersiveCraftHandler
|
||||
function CraftSystem:getImmersiveCraftHandler(type)
|
||||
local handler = self.ImmersiveCraftHandlers[type]
|
||||
assert(handler ~= nil)
|
||||
|
||||
return handler
|
||||
end
|
||||
|
||||
---@param type CraftSystem.ProcessingCraftType
|
||||
---@return CraftSystem.ProcessingCraftHandler
|
||||
function CraftSystem:getProcessingCraftHandler(type)
|
||||
local handler = self.ProcessingCraftHandlers[type]
|
||||
assert(handler ~= nil)
|
||||
|
||||
return handler
|
||||
end
|
||||
|
||||
-- Registration of craft types:
|
||||
registerPrimitiveCraftType('inside_player_inventory', {})
|
||||
-- Debug:
|
||||
registerImmersiveCraftType('workbench', {})
|
||||
registerProcessingCraftType('test', {})
|
||||
|
||||
|
||||
--- Registration methods ---
|
||||
|
||||
---@param type CraftSystem.PrimitiveCraftType
|
||||
---@param craftName string
|
||||
---@param def CraftSystem.PrimitiveCraftDef
|
||||
function CraftSystem:registerPrimitiveCraft(type, craftName, def)
|
||||
local handler = self:getPrimitiveCraftHandler(type)
|
||||
|
||||
handler:registerCraft(craftName, def)
|
||||
end
|
||||
|
||||
---@param type CraftSystem.ImmersiveCraftType
|
||||
---@param craftName string
|
||||
---@param def CraftSystem.ImmersiveCraftDef
|
||||
function CraftSystem:registerImmersiveCraft(type, craftName, def)
|
||||
local handler = self:getImmersiveCraftHandler(type)
|
||||
|
||||
handler:registerCraft(craftName, def)
|
||||
end
|
||||
|
||||
---@param type CraftSystem.ProcessingCraftType
|
||||
---@param craftName string
|
||||
---@param def CraftSystem.ProcessingCraftDef
|
||||
function CraftSystem:registerProcessingCraft(type, craftName, def)
|
||||
local handler = self:getProcessingCraftHandler(type)
|
||||
|
||||
handler:registerCraft(craftName, def)
|
||||
end
|
||||
|
||||
--- Methods for performing crafting ---
|
||||
|
||||
|
||||
---@param craft CraftSystem.BaseCraft
|
||||
---@param recipeIndex integer
|
||||
---@param count integer
|
||||
---@return ItemStack[] materialStacks A table containing the items required for crafting.
|
||||
---@return table<string, integer> materialGroups A table containing the item groups required for crafting.
|
||||
local function getMaterials(craft, recipeIndex, count)
|
||||
local materialStacks = {}
|
||||
local materialGroups = {}
|
||||
|
||||
for _, itemName in ipairs(craft:getRecipe(recipeIndex)) do
|
||||
local group = itemName:match('group:(%S+)')
|
||||
local materialCount = itemName:match('group:%S+ (%S+)') or 1
|
||||
|
||||
if group == nil then
|
||||
local item = ItemStack(itemName)
|
||||
item:set_count(item:get_count() * count)
|
||||
|
||||
table.insert(materialStacks, item)
|
||||
else
|
||||
materialGroups[group] = (tonumber(materialCount) or 1) * count
|
||||
end
|
||||
if type == 'shapeless' then
|
||||
craftList = CraftSystem.shapelessCraftsList
|
||||
elseif type == 'processual' then
|
||||
craftList = CraftSystem.processualCraftsList
|
||||
else
|
||||
error(string.format('Craft type `%s` does not exist.', type))
|
||||
end
|
||||
|
||||
return materialStacks, materialGroups
|
||||
return craftList
|
||||
end
|
||||
|
||||
---Check if the player has the required items.
|
||||
---@param materialStacks ItemStack[]
|
||||
---@param inventory InvRef
|
||||
---@return boolean
|
||||
local function checkMaterialStacks(materialStacks, inventory)
|
||||
for _, item in ipairs(materialStacks) do
|
||||
if not inventory:contains_item('main', item) then
|
||||
return false
|
||||
end
|
||||
end
|
||||
---@param type CraftSystem.Craft.Type
|
||||
---@param group CraftSystem.Craft.Group
|
||||
---@return table<string, table>
|
||||
local function getCraftGroup(type, group)
|
||||
local craftList = getCraftList(type)
|
||||
|
||||
return true
|
||||
---@type table<string, table>?
|
||||
local craftGroup = craftList[group]
|
||||
|
||||
assert(craftGroup ~= nil, string.format('Craft group `%s` does not exist.', type))
|
||||
|
||||
return craftGroup
|
||||
end
|
||||
|
||||
---Check whether the player has the required number of items with the required group for crafting.
|
||||
---@param materialGroups table<string, integer>
|
||||
---@param inventory InvRef
|
||||
---@return boolean
|
||||
---@return ItemStack[] materialStacks A list of item stacks that match the required material groups.
|
||||
local function checkMaterialGroups(materialGroups, inventory)
|
||||
local materialStacks = {}
|
||||
---@param type CraftSystem.Craft.Type
|
||||
---@param group CraftSystem.Craft.Group
|
||||
function CraftSystem.registerCraftGroup(type, group)
|
||||
local craftList = getCraftList(type)
|
||||
|
||||
local mainList = inventory:get_list('main')
|
||||
for group, count in pairs(materialGroups) do
|
||||
for _, item in ipairs(mainList) do
|
||||
if core.get_item_group(item:get_name(), group) > 0 then
|
||||
local itemCount = item:get_count()
|
||||
if count > itemCount then
|
||||
count = count - itemCount
|
||||
table.insert(materialStacks, item)
|
||||
else
|
||||
item:set_count(count)
|
||||
table.insert(materialStacks, item)
|
||||
count = 0
|
||||
end
|
||||
end
|
||||
end
|
||||
assert(craftList[group] == nil, string.format('Craft group `%s` is already registered.', type))
|
||||
|
||||
if count > 0 then
|
||||
return false, {}
|
||||
end
|
||||
end
|
||||
|
||||
return true, materialStacks
|
||||
craftList[group] = {}
|
||||
end
|
||||
|
||||
---Checks whether the player can perform crafting (whether he has the required materials in his inventory).
|
||||
---@param player Player
|
||||
---@param craft CraftSystem.BaseCraft
|
||||
---@param recipeIndex integer
|
||||
---@param count integer
|
||||
---@return boolean check true if craft can be produced
|
||||
---@return ItemStack[] materialStacks list of itemStacks for crafting
|
||||
function CraftSystem:checkPossiblePlayerInventoryCrafting(player, craft, recipeIndex, count, flags)
|
||||
local inventory = player:get_inventory()
|
||||
---@param recipe CraftSystem.Craft.Recipe
|
||||
---@return string
|
||||
function CraftSystem.getCraftHash(recipe)
|
||||
table.sort(recipe)
|
||||
|
||||
local OutputStack = ItemStack(craft.output)
|
||||
OutputStack:set_count(OutputStack:get_count() * count)
|
||||
local hash = ''
|
||||
|
||||
local materialStacks, materialGroups = getMaterials(craft, recipeIndex, count)
|
||||
|
||||
local isHaveStacks = checkMaterialStacks(materialStacks, inventory)
|
||||
if not isHaveStacks then
|
||||
core.chat_send_player(player:get_player_name(), 'Not enough materials for crafting!')
|
||||
return false, {}
|
||||
for i = 0, #recipe-1 do
|
||||
hash = hash..recipe[i]..HASH_SPLITTER
|
||||
end
|
||||
|
||||
local isHaveGroups, materialGroupStacks = checkMaterialGroups(materialGroups, inventory)
|
||||
if not isHaveGroups then
|
||||
core.chat_send_player(player:get_player_name(), 'Not enough materials for crafting!')
|
||||
return false, {}
|
||||
end
|
||||
|
||||
materialStacks = tableJoin(materialStacks, materialGroupStacks)
|
||||
|
||||
|
||||
return true, materialStacks
|
||||
return hash..recipe[#recipe]
|
||||
end
|
||||
|
||||
return CraftSystem
|
||||
---@param craftDef CraftSystem.ShapelessCraft|CraftSystem.ProcessualCraft
|
||||
function CraftSystem.registerCraft(craftDef)
|
||||
local craftGroup = getCraftGroup(craftDef.type, craftDef.group)
|
||||
|
||||
local hash = CraftSystem.getCraftHash(craftDef.recipe)
|
||||
|
||||
table.insert(craftGroup[hash], craftDef)
|
||||
end
|
||||
|
||||
---@param type CraftSystem.Craft.Type
|
||||
---@param group CraftSystem.Craft.Group
|
||||
---@return CraftSystem.ShapelessCraft[] |
|
||||
--- CraftSystem.processualCraftsList[] |
|
||||
--- nil
|
||||
function CraftSystem.getCraftResults(type, group, recipe)
|
||||
local craftGroup = getCraftGroup(type, group)
|
||||
|
||||
local hash = CraftSystem.getCraftHash(recipe)
|
||||
|
||||
return craftGroup[hash]
|
||||
end
|
||||
|
||||
return CraftSystem
|
||||
@@ -1,156 +0,0 @@
|
||||
---A text indicator of the presence or absence
|
||||
---of a material in the player's inventory.
|
||||
local CHECK = {YES = '[x]', NO = '[ ]', EMPTY = '-'}
|
||||
|
||||
---@class CraftSystem.BaseCraft : Class
|
||||
---@field name string
|
||||
---@field recipe ItemStackString[]
|
||||
---@field altRecipes CraftSystem.CraftRecipe[]
|
||||
---@field output ItemStackString
|
||||
---@field group CraftSystem.CraftGroup
|
||||
local BaseCraft = Class:extend({})
|
||||
|
||||
---Definition table for the `CraftSystem.BaseCraft`.
|
||||
---@class CraftSystem.BaseCraftDef
|
||||
---@field recipe ItemStackString[]
|
||||
---@field altRecipes CraftSystem.CraftRecipe[]?
|
||||
---@field output ItemStackString
|
||||
---@field group CraftSystem.CraftGroup?
|
||||
|
||||
---@param name string
|
||||
---@param def CraftSystem.BaseCraftDef
|
||||
---@return CraftSystem.BaseCraft
|
||||
function BaseCraft:new(name, def)
|
||||
---@type CraftSystem.BaseCraft
|
||||
local instance = self:getInstance({})
|
||||
instance.name = name
|
||||
instance.recipe = def.recipe
|
||||
instance.altRecipes = def.altRecipes or {}
|
||||
instance.output = def.output
|
||||
instance.group = def.group
|
||||
|
||||
return instance
|
||||
end
|
||||
|
||||
---@param material ItemStack
|
||||
---@param count number
|
||||
---@param list ItemStack[]?
|
||||
---@return string
|
||||
local function getCheckMaterialItem(material, count, list)
|
||||
if list == nil then
|
||||
return CHECK.EMPTY
|
||||
end
|
||||
|
||||
local materialName = material:get_name()
|
||||
|
||||
for _, item in ipairs(list) do
|
||||
if materialName == item:get_name() then
|
||||
local itemCount = item:get_count()
|
||||
if count > itemCount then
|
||||
count = count - itemCount
|
||||
else
|
||||
return CHECK.YES
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
return CHECK.NO
|
||||
end
|
||||
|
||||
---@param material string
|
||||
---@param count number
|
||||
---@param list ItemStack[]?
|
||||
---@return string
|
||||
local function getCheckMaterialGroup(material, count, list)
|
||||
if list == nil then
|
||||
return CHECK.EMPTY
|
||||
end
|
||||
|
||||
for _, item in ipairs(list) do
|
||||
if core.get_item_group(item:get_name(), material) > 0 then
|
||||
local itemCount = item:get_count()
|
||||
if count > itemCount then
|
||||
count = count - itemCount
|
||||
else
|
||||
return CHECK.YES
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
return CHECK.NO
|
||||
end
|
||||
|
||||
---Returns the crafting recipe corresponding to the index.
|
||||
---@param index integer Recipe number. If `0` is specified,
|
||||
--- the primary craft (`craft.recipe`) will be used;
|
||||
--- if `1` or greater, the alternative craft
|
||||
--- corresponding to the index will be used (`craft.altRecipes`).
|
||||
---@return CraftSystem.CraftRecipe
|
||||
function BaseCraft:getRecipe(index)
|
||||
local recipe
|
||||
if index == 0 or self.altRecipes == nil then
|
||||
recipe = self.recipe
|
||||
else
|
||||
if index > #self.altRecipes then
|
||||
recipe = self.altRecipes[#self.altRecipes]
|
||||
else
|
||||
recipe = self.altRecipes[index]
|
||||
end
|
||||
end
|
||||
assert(recipe ~= nil)
|
||||
|
||||
return recipe
|
||||
end
|
||||
|
||||
---@param recipeIndex integer?
|
||||
---@param mainList ItemStack[]?
|
||||
---@return string
|
||||
function BaseCraft:recipeToString(recipeIndex, mainList)
|
||||
local recipe
|
||||
if recipeIndex == nil or recipeIndex == 0 or self.altRecipes == nil then
|
||||
recipe = self.recipe
|
||||
else
|
||||
if recipeIndex > #self.altRecipes then
|
||||
recipe = self.altRecipes[#self.altRecipes]
|
||||
else
|
||||
recipe = self.altRecipes[recipeIndex]
|
||||
end
|
||||
end
|
||||
assert(recipe ~= nil)
|
||||
|
||||
local recipeDesc = ''
|
||||
for _, itemName in ipairs(recipe) do
|
||||
local group, count = itemName:match('group:(%S+)'), itemName:match('group:%S+ (%S+)') or 1
|
||||
|
||||
if group == nil then
|
||||
local recipeItem = ItemStack(itemName)
|
||||
recipeDesc = recipeDesc..('%s %s x%s\n'):format(
|
||||
getCheckMaterialItem(recipeItem, recipeItem:get_count(), mainList),
|
||||
core.strip_colors(recipeItem:get_definition()._title),
|
||||
recipeItem:get_count())
|
||||
else
|
||||
recipeDesc = recipeDesc..('%s any item from the group %s x%s\n'):format(
|
||||
getCheckMaterialGroup(group, count, mainList),
|
||||
group,
|
||||
count)
|
||||
end
|
||||
end
|
||||
|
||||
return recipeDesc
|
||||
end
|
||||
|
||||
---@param recipeIndex integer?
|
||||
---@param mainList ItemStack[]?
|
||||
---@return string
|
||||
function BaseCraft:toString(recipeIndex, mainList)
|
||||
local outputItem = ItemStack(self.output)
|
||||
local outputItemSettings = Smc.getItemDefinition(outputItem).settings
|
||||
|
||||
local craftDesc = ('%s\n\nNeeded:\n%s'):format(
|
||||
outputItemSettings._title,
|
||||
self:recipeToString(recipeIndex, mainList))
|
||||
|
||||
return craftDesc
|
||||
end
|
||||
|
||||
return BaseCraft
|
||||
@@ -1,125 +0,0 @@
|
||||
local tableInsert = table.insert
|
||||
local stringMatch = string.match
|
||||
|
||||
local PLAYERS_KNOW_ALL_RECIPES = true
|
||||
|
||||
---Abstract class for handling crafting.
|
||||
---@class CraftSystem.BaseCraftHandler : Class
|
||||
---@field baseType CraftSystem.BaseCraftType
|
||||
---@field type CraftSystem.CraftType
|
||||
---@field defaultCraftDef CraftSystem.BaseCraftDef
|
||||
---
|
||||
---@field craftsByName table<string, CraftSystem.BaseCraft>
|
||||
---@field craftsByGroup table<CraftSystem.CraftGroup, CraftSystem.BaseCraft[]>
|
||||
---@field craftsList CraftSystem.BaseCraft[]
|
||||
---@field groupedCrafts (CraftSystem.BaseCraft[]|CraftSystem.BaseCraft)[]
|
||||
---@field learnedCrafts table<string, CraftSystem.BaseCraft[]>
|
||||
---@field learnedGroupedCrafts table<string, (CraftSystem.BaseCraft[]|CraftSystem.BaseCraft)[]>
|
||||
local BaseCraftHandler = Class:extend({
|
||||
craftsByName = {},
|
||||
craftsByGroup = {},
|
||||
craftsList = {},
|
||||
groupedCrafts = {},
|
||||
learnedCrafts = {},
|
||||
learnedGroupedCrafts = {},
|
||||
})
|
||||
|
||||
---@class CraftSystem.BaseCraftHandlerDef
|
||||
---@field defaultCraftDef CraftSystem.BaseCraftDef?
|
||||
|
||||
---@param baseType CraftSystem.BaseCraftType
|
||||
---@param type CraftSystem.CraftType
|
||||
---@param def CraftSystem.BaseCraftHandlerDef
|
||||
---@return CraftSystem.BaseCraftHandler
|
||||
function BaseCraftHandler:new(baseType, type, def)
|
||||
---@type CraftSystem.BaseCraftHandler
|
||||
local instance = self:getInstance({})
|
||||
instance.baseType = baseType
|
||||
instance.type = type
|
||||
instance.defaultCraftDef = def.defaultCraftDef or {}
|
||||
|
||||
return instance
|
||||
end
|
||||
|
||||
---@param craftName string
|
||||
---@return CraftSystem.BaseCraft
|
||||
function BaseCraftHandler:getCraftByName(craftName)
|
||||
local craft = self.craftsByName[craftName]
|
||||
|
||||
assert(craft ~= nil, ('A craft `%s` not exists.'):format(
|
||||
craftName))
|
||||
|
||||
return craft
|
||||
end
|
||||
|
||||
---@param craftGroup CraftSystem.CraftGroup
|
||||
---@return CraftSystem.BaseCraft[]
|
||||
function BaseCraftHandler:getCraftsByGroup(craftGroup)
|
||||
local crafts = self.craftsByGroup[craftGroup]
|
||||
|
||||
assert(crafts ~= nil, ('A craft with group `%s` not exists.'):format(
|
||||
craftGroup))
|
||||
|
||||
return crafts
|
||||
end
|
||||
|
||||
---@param playerName string
|
||||
---@return (CraftSystem.BaseCraft[]|CraftSystem.BaseCraft)[]
|
||||
function BaseCraftHandler:getLearnedCrafts(playerName)
|
||||
if PLAYERS_KNOW_ALL_RECIPES then
|
||||
return self.groupedCrafts
|
||||
end
|
||||
|
||||
local crafts = self.learnedGroupedCrafts[playerName]
|
||||
|
||||
if crafts == nil then
|
||||
crafts = {}
|
||||
self.learnedGroupedCrafts[playerName] = crafts
|
||||
end
|
||||
|
||||
return crafts
|
||||
end
|
||||
|
||||
---@param crafts CraftSystem.BaseCraft[]
|
||||
---@param pattern string
|
||||
---@return CraftSystem.BaseCraft[]
|
||||
local function getMathedCrafts(crafts, pattern)
|
||||
local matchedCrafts = {}
|
||||
|
||||
for _, craft in ipairs(crafts) do
|
||||
local outputItem = ItemStack(craft.output)
|
||||
local itemSettings = Smc.getItemDefinition(outputItem).settings
|
||||
local ruName = core.get_translated_string('ru', itemSettings._title)
|
||||
local enName = core.get_translated_string('en', itemSettings._title)
|
||||
|
||||
if stringMatch(outputItem:get_name(), pattern) or
|
||||
stringMatch(ruName, pattern) or
|
||||
stringMatch(enName, pattern) then
|
||||
tableInsert(matchedCrafts, craft)
|
||||
end
|
||||
end
|
||||
|
||||
return matchedCrafts
|
||||
end
|
||||
|
||||
---@param playerName string
|
||||
---@param pattern string
|
||||
---@return CraftSystem.BaseCraft[]
|
||||
function BaseCraftHandler:getLearnedCraftsMatch(playerName, pattern)
|
||||
if PLAYERS_KNOW_ALL_RECIPES then
|
||||
return getMathedCrafts(self.craftsList, pattern)
|
||||
end
|
||||
|
||||
local crafts = self.learnedCrafts[playerName]
|
||||
|
||||
if crafts == nil then
|
||||
crafts = {}
|
||||
self.learnedCrafts[playerName] = crafts
|
||||
end
|
||||
|
||||
return crafts
|
||||
end
|
||||
|
||||
--TODO: сохранять выученные крафты игроков в сторадже
|
||||
|
||||
return BaseCraftHandler
|
||||
@@ -1,196 +0,0 @@
|
||||
local modInfo = Mod.getInfo('smc__core__craft_system')
|
||||
local require = modInfo.require
|
||||
|
||||
---@type CraftSystem.BaseCraft
|
||||
local BaseCraft = require('CraftSystem.BaseCraft')
|
||||
---@type CraftSystem.ImmersiveCraftCounter
|
||||
local ImmersiveCraftCounter = require('CraftSystem.ImmersiveCraftCounter')
|
||||
|
||||
---Types of immersive stages.
|
||||
---@class CraftSystem.StagesTypes : table<CraftSystem.ImmersiveCraftStage.Type, CraftSystem.ImmersiveCraftStage>
|
||||
local stageTypes = {
|
||||
---@type CraftSystem.ImmersiveCraftStage.TappingStage
|
||||
tapping = require('CraftSystem.ImmersiveCraftStage.TappingStage'),
|
||||
}
|
||||
|
||||
---Immersive crafting aimed at a more logical process of crafting items.
|
||||
---@class CraftSystem.ImmersiveCraft : CraftSystem.BaseCraft
|
||||
---@field startStageName string
|
||||
---@field stagesByName table<string, CraftSystem.ImmersiveCraftStage>
|
||||
local ImmersiveCraft = BaseCraft:extend({})
|
||||
|
||||
---Definition table for the `CraftSystem.ImmersiveCraft`.
|
||||
---
|
||||
---**Only for EmmyLua.**
|
||||
---@class CraftSystem.ImmersiveCraftDef : CraftSystem.BaseCraftDef
|
||||
---@field startStageName string
|
||||
---@field stages CraftSystem.ImmersiveCraftStageDef[]
|
||||
|
||||
---@param name string
|
||||
---@param def CraftSystem.ImmersiveCraftDef
|
||||
---@return CraftSystem.ImmersiveCraft
|
||||
function ImmersiveCraft:new(name, def)
|
||||
---@type table<string, CraftSystem.ImmersiveCraftStage>
|
||||
local stagesByName = {}
|
||||
|
||||
for _, stageDef in ipairs(def.stages) do
|
||||
local StageClass = stageTypes[stageDef.type]
|
||||
|
||||
stageDef.craftName = name
|
||||
local stage = StageClass:new(stageDef)
|
||||
|
||||
stagesByName[stageDef.name] = stage
|
||||
end
|
||||
|
||||
---@type CraftSystem.ImmersiveCraft
|
||||
local instance = self:getInstance(BaseCraft:new(name, def))
|
||||
instance.startStageName = def.startStageName
|
||||
instance.stagesByName = stagesByName
|
||||
|
||||
-- Subscribe to an event that will determine that the player has completed the crafting stage.
|
||||
Events:subscribe('craft_system:next_immersive_stage:'..name,
|
||||
---@param eventName string
|
||||
---@param stage CraftSystem.ImmersiveCraftStage
|
||||
---@param pos MapVector
|
||||
---@param Player Player
|
||||
function(eventName, stage, pos, Player)
|
||||
local nextStageName = stage.nextStage
|
||||
|
||||
if nextStageName == nil then
|
||||
instance:endCraft(pos, Player)
|
||||
else
|
||||
local nextStage = instance.stagesByName[nextStageName]
|
||||
|
||||
---@type ImmersiveWorkStation.MetaData
|
||||
local meta = core.get_meta(pos)
|
||||
meta:set_string('stage_name', nextStage.name)
|
||||
|
||||
nextStage:startHandler(pos, Player)
|
||||
end
|
||||
end)
|
||||
|
||||
return instance
|
||||
end
|
||||
|
||||
---Initialize the start of the immersive crafting process.
|
||||
---
|
||||
---Returns `true` if the crafting process was running.
|
||||
---@param pos MapVector
|
||||
---@param player Player
|
||||
---@param amount integer
|
||||
---@return boolean
|
||||
function ImmersiveCraft:startCraft(pos, player, amount)
|
||||
---@type ImmersiveWorkStation.MetaData
|
||||
local meta = core.get_meta(pos)
|
||||
local craftName = meta:get_string('craft_name')
|
||||
if craftName ~= '' then
|
||||
core.chat_send_player(player:get_player_name(), 'The workbench is occupied by another craft.')
|
||||
return false
|
||||
end
|
||||
|
||||
if not ImmersiveCraftCounter:addCraft(pos, player:get_player_name()) then
|
||||
core.chat_send_player(player:get_player_name(),
|
||||
'The limit of simultaneously active crafts has been reached: '..
|
||||
'complete or cancel active crafts to start a new one')
|
||||
|
||||
return false
|
||||
end
|
||||
|
||||
local stage = self.stagesByName[self.startStageName]
|
||||
|
||||
meta:set_string('player_name', player:get_player_name())
|
||||
meta:set_string('craft_name', self.name)
|
||||
meta:set_string('stage_name', stage.name)
|
||||
meta:set_float('craft_amount', amount)
|
||||
|
||||
stage:startHandler(pos, player)
|
||||
|
||||
return true
|
||||
end
|
||||
|
||||
---Complete the immersive crafting process.
|
||||
---@param pos MapVector
|
||||
---@param player Player
|
||||
function ImmersiveCraft:endCraft(pos, player)
|
||||
---@type ImmersiveWorkStation.MetaData
|
||||
local meta = core.get_meta(pos)
|
||||
local playerName = meta:get_string('player_name')
|
||||
assert(playerName ~= '')
|
||||
local amount = meta:get_float('craft_amount')
|
||||
assert(amount ~= 0)
|
||||
|
||||
-- Drop the result of crafting.
|
||||
local dropPos = vector.new(pos) + vector.new(0, 0.9,0)
|
||||
for i=1, amount do
|
||||
core.item_drop(ItemStack(self.output), nil, dropPos)
|
||||
end
|
||||
|
||||
ImmersiveCraftCounter:removeCraft(pos, playerName)
|
||||
|
||||
-- Clear craft data
|
||||
meta:set_string('player_name', '')
|
||||
meta:set_string('craft_name', '')
|
||||
meta:set_string('stage_name', '')
|
||||
meta:set_float('craft_amount', 0)
|
||||
meta:set_string('stage_data', '')
|
||||
end
|
||||
|
||||
---Stop the crafting process and free up the workbench.
|
||||
---@param pos MapVector
|
||||
function ImmersiveCraft:abortCraft(pos)
|
||||
---@type ImmersiveWorkStation.MetaData
|
||||
local meta = core.get_meta(pos)
|
||||
local playerName = meta:get_string('player_name')
|
||||
assert(playerName ~= '')
|
||||
local stageName = meta:get_string('stage_name')
|
||||
assert(stageName ~= '')
|
||||
|
||||
local stage = self.stagesByName[stageName]
|
||||
stage:abortHandler(pos)
|
||||
|
||||
-- Clear craft data
|
||||
meta:set_string('player_name', '')
|
||||
meta:set_string('craft_name', '')
|
||||
meta:set_string('stage_name', '')
|
||||
meta:set_float('craft_amount', 0)
|
||||
meta:set_string('stage_data', '')
|
||||
|
||||
ImmersiveCraftCounter:removeCraft(pos, playerName)
|
||||
end
|
||||
|
||||
---Returns a human-readable description of the crafting process.
|
||||
---@return string
|
||||
function ImmersiveCraft:recipeToString(recipeIndex, mainList)
|
||||
local recipeDesc = ''
|
||||
---@type string?
|
||||
local stageName = self.startStageName
|
||||
local stages = self.stagesByName
|
||||
|
||||
local count = 1
|
||||
while stageName ~= nil do
|
||||
local stage = stages[stageName]
|
||||
|
||||
recipeDesc = recipeDesc..tostring(count)..'. '..stage:toString()..'\n'
|
||||
|
||||
stageName = stage.nextStage
|
||||
end
|
||||
|
||||
return recipeDesc
|
||||
end
|
||||
|
||||
---@param recipeIndex integer?
|
||||
---@param mainList ItemStack[]?
|
||||
---@return string
|
||||
function ImmersiveCraft:toString(recipeIndex, mainList)
|
||||
local outputItem = ItemStack(self.output)
|
||||
local outputItemSettings = Smc.getItemDefinition(outputItem).settings
|
||||
|
||||
local craftDesc = ('%s\n\nRecipe:\n%s\nActions:\n%s'):format(
|
||||
outputItemSettings._title,
|
||||
BaseCraft.recipeToString(self, recipeIndex, mainList),
|
||||
self:recipeToString(recipeIndex, mainList))
|
||||
|
||||
return craftDesc
|
||||
end
|
||||
|
||||
return ImmersiveCraft
|
||||
@@ -1,78 +0,0 @@
|
||||
local posToString, getSize = core.pos_to_string, table.get_size
|
||||
|
||||
local CRAFT_LIMIT_PER_PLAYER = 2
|
||||
local CRAFT_LIMIT_PER_SERVER = 10
|
||||
|
||||
local modStorage = core.get_mod_storage()
|
||||
|
||||
---@param key string
|
||||
---@return table
|
||||
local function getStorageTable(key)
|
||||
return core.deserialize(modStorage:get_string(key)) or {}
|
||||
end
|
||||
|
||||
---@param key string
|
||||
---@param t table
|
||||
local function setStorageTable(key, t)
|
||||
modStorage:set_string(key, core.serialize(t))
|
||||
end
|
||||
|
||||
---Designed to keep track of active immersive
|
||||
---crafts so as not to overload the server.
|
||||
---
|
||||
---The counter is individual for each player,
|
||||
---but the total number of active crafts is also tracked.
|
||||
---@class CraftSystem.ImmersiveCraftCounter
|
||||
---@field craftsCountForPlayers table<string, table<string, boolean>>
|
||||
---@field craftsCountForServer table<string, boolean>
|
||||
local ImmersiveCraftCounter = {
|
||||
craftsCountForPlayers = getStorageTable('crafts_count_for_players'),
|
||||
craftsCountForServer = getStorageTable('crafts_count_for_serves')
|
||||
}
|
||||
|
||||
---Add craft to the counter.
|
||||
---
|
||||
---Returns `false` if the counter is already full.
|
||||
---@param pos MapVector
|
||||
---@param playerName string
|
||||
---@return boolean
|
||||
function ImmersiveCraftCounter:addCraft(pos, playerName)
|
||||
if self.craftsCountForPlayers[playerName] == nil then
|
||||
self.craftsCountForPlayers[playerName] = {}
|
||||
end
|
||||
|
||||
if getSize(self.craftsCountForPlayers[playerName]) >= CRAFT_LIMIT_PER_PLAYER then
|
||||
return false
|
||||
end
|
||||
|
||||
if getSize(self.craftsCountForServer) >= CRAFT_LIMIT_PER_SERVER then
|
||||
return false
|
||||
end
|
||||
|
||||
local posString = posToString(pos)
|
||||
self.craftsCountForPlayers[playerName][posString] = true
|
||||
self.craftsCountForServer[posString] = true
|
||||
|
||||
return true
|
||||
end
|
||||
|
||||
---Remove craft from the counter.
|
||||
---@param pos MapVector
|
||||
---@param playerName string
|
||||
function ImmersiveCraftCounter:removeCraft(pos, playerName)
|
||||
local playerCrafts = self.craftsCountForPlayers[playerName]
|
||||
if playerCrafts == nil then
|
||||
return
|
||||
end
|
||||
|
||||
local posString = posToString(pos)
|
||||
playerCrafts[posString] = nil
|
||||
self.craftsCountForServer[posString] = nil
|
||||
end
|
||||
|
||||
core.register_on_shutdown(function()
|
||||
setStorageTable('crafts_count_for_players', ImmersiveCraftCounter.craftsCountForPlayers)
|
||||
setStorageTable('crafts_count_for_server', ImmersiveCraftCounter.craftsCountForServer)
|
||||
end)
|
||||
|
||||
return ImmersiveCraftCounter
|
||||
@@ -1,76 +0,0 @@
|
||||
local tableInsert, tableSort, tableJoin = table.insert, table.sort, table.join
|
||||
|
||||
local modInfo = Mod.getInfo('smc__core__craft_system')
|
||||
local require = modInfo.require
|
||||
|
||||
---@type CraftSystem.BaseCraftHandler
|
||||
local BaseCraftHandler = require('CraftSystem.BaseCraftHandler')
|
||||
---@type CraftSystem.ImmersiveCraft
|
||||
local ImmersiveCraft = require('CraftSystem.ImmersiveCraft')
|
||||
|
||||
---A handler for immersive crafting that requires the player to complete
|
||||
---crafting stages and interact with entities (crafting nodes)
|
||||
---@class CraftSystem.ImmersiveCraftHandler : CraftSystem.BaseCraftHandler
|
||||
---@field defaultCraftDef CraftSystem.BaseCraftDef
|
||||
---
|
||||
---@field new fun(self:CraftSystem.ImmersiveCraftHandler, baseType:CraftSystem.BaseCraftType, type:CraftSystem.ImmersiveCraftType, def:CraftSystem.ImmersiveCraftHandlerDef):CraftSystem.ImmersiveCraftHandler
|
||||
---@field getCraftByName fun(self, craftName:string):CraftSystem.ImmersiveCraft
|
||||
---@field getCraftsByGroup fun(self, craftGroup):CraftSystem.ImmersiveCraft[]
|
||||
---@field getLearnedCrafts fun(self, playerName):table<string, CraftSystem.ImmersiveCraft>
|
||||
local ImmersiveCraftHandler = BaseCraftHandler:extend({})
|
||||
|
||||
---@class CraftSystem.ImmersiveCraftHandlerDef : CraftSystem.BaseCraftHandlerDef
|
||||
---@field defaultCraftDef CraftSystem.ImmersiveCraftDef?
|
||||
|
||||
---Register an immersive crafting experience that requires the player to complete
|
||||
---one or more crafting stages that involve interaction with entities (crafting nodes)
|
||||
---@param craftName string
|
||||
---@param def CraftSystem.ImmersiveCraftDef
|
||||
function ImmersiveCraftHandler:registerCraft(craftName, def)
|
||||
assert(self.craftsByName[craftName] == nil, ('A craft named `%s` already exists.'):format(
|
||||
craftName))
|
||||
|
||||
local def = table.merge(def, self.defaultCraftDef)
|
||||
|
||||
local group = 'craft_group:' .. (def.group or 'UNDEFINED')
|
||||
def.group = group
|
||||
|
||||
local craft = (ImmersiveCraft:new(craftName, def))
|
||||
|
||||
if self.craftsByGroup[group] == nil then
|
||||
self.craftsByGroup[group] = {}
|
||||
end
|
||||
|
||||
self.craftsByName[craftName] = craft
|
||||
tableInsert(self.craftsByGroup[group], craft)
|
||||
tableInsert(self.craftsList, craft)
|
||||
end
|
||||
|
||||
-- Sort the list of crafts in alphabetical order by product name and combine crafts into groups.
|
||||
-- Provides a convenient list of crafting items in the player's inventory.
|
||||
core.register_on_mods_loaded(function()
|
||||
for groupName, crafts in pairs(ImmersiveCraftHandler.craftsByGroup) do
|
||||
tableSort(crafts, function(a, b)
|
||||
if a.output < b.output then
|
||||
return true
|
||||
end
|
||||
end)
|
||||
|
||||
if groupName ~= 'craft_group:UNDEFINED' then
|
||||
tableInsert(ImmersiveCraftHandler.groupedCrafts, crafts)
|
||||
else
|
||||
ImmersiveCraftHandler.groupedCrafts = tableJoin(ImmersiveCraftHandler.groupedCrafts, crafts)
|
||||
end
|
||||
end
|
||||
|
||||
tableSort(ImmersiveCraftHandler.groupedCrafts, function(a, b)
|
||||
local outputA = (a[1] and a[1].output) or a.output
|
||||
local outputB = (b[1] and b[1].output) or b.output
|
||||
|
||||
if outputA < outputB then
|
||||
return true
|
||||
end
|
||||
end)
|
||||
end)
|
||||
|
||||
return ImmersiveCraftHandler
|
||||
@@ -1,14 +0,0 @@
|
||||
---@type Creature
|
||||
local Creature = Mod.getInfo('smc__core__creature').require('Creature')
|
||||
|
||||
---The entity the player interacts with during immersive crafting.
|
||||
---@class CraftSystem.ImmersiveCraftNode : Creature
|
||||
local ImmersiveCraftNode = Creature:getExtended({
|
||||
settings = {
|
||||
_name = 'craft_system:immersive_craft_node',
|
||||
_add_mod_name = false,
|
||||
initial_properties = {},
|
||||
}
|
||||
})
|
||||
|
||||
return ImmersiveCraftNode
|
||||
@@ -1,93 +0,0 @@
|
||||
local modInfo = Mod.getInfo('smc__core__craft_system')
|
||||
local require = modInfo.require
|
||||
|
||||
---@type CraftSystem.ImmersiveCraftNode
|
||||
local ImmersiveCraftNode = require('CraftSystem.ImmersiveCraftNode')
|
||||
|
||||
---A class that extends `Creature.LuaEntity` to annotate custom fields needed for immersive crafting.
|
||||
---
|
||||
---**Only for EmmyLua.**
|
||||
---@class CraftSystem.ImmersiveCraftNode.LuaTappingNode : Creature.LuaEntity
|
||||
---The name of the item that the crafting node display.
|
||||
---@field _item_name ItemStackString
|
||||
---Sets the entity display of the item. If the item stack was not transferred, `self._item_name` is used.
|
||||
---@field _set_item fun(self:CraftSystem.ImmersiveCraftNode.LuaTappingNode, itemName:ItemStackString?)
|
||||
---@field _craft_name string
|
||||
---@field _stage_name string
|
||||
---@field _work_station_pos MapVector
|
||||
|
||||
-- A crafting node (entity) that is used in the tapping crafting stage.
|
||||
local tappingNode = ImmersiveCraftNode:new({
|
||||
settings = {
|
||||
_name = 'craft_system:tapping_node',
|
||||
_add_mod_name = false,
|
||||
|
||||
---@type ObjectProperties
|
||||
initial_properties = {
|
||||
visual = 'wielditem',
|
||||
visual_size = {x=0.5, y=0.5, z=0.5},
|
||||
collisionbox = {
|
||||
-0.375, -0.375, -0.375,
|
||||
0.375, 0.375, 0.375
|
||||
},
|
||||
},
|
||||
|
||||
_item_name = '',
|
||||
_craft_name = '',
|
||||
_stage_name = '',
|
||||
_work_station_pos = {},
|
||||
},
|
||||
callbacks = {
|
||||
---@param luaEntity CraftSystem.ImmersiveCraftNode.LuaTappingNode
|
||||
on_activate = function(luaEntity, staticdata, dtime)
|
||||
---@type CraftSystem.ImmersiveCraftStage.TappingNode.InitParams?
|
||||
local params = core.deserialize(staticdata)
|
||||
|
||||
if params ~= nil then
|
||||
luaEntity._item_name = params.targetItem
|
||||
luaEntity._craft_name = params.craftName
|
||||
luaEntity._stage_name = params.stageName
|
||||
luaEntity._work_station_pos = params.WorkStationPos
|
||||
end
|
||||
|
||||
-- we set the appearance of the item to be processed on the crafting node.
|
||||
luaEntity:_set_item(luaEntity._item_name)
|
||||
-- We add an immortal group to the entity so that it cannot be killed.
|
||||
luaEntity.object:set_armor_groups({immortal = 1})
|
||||
end,
|
||||
|
||||
---@param luaEntity CraftSystem.ImmersiveCraftNode.LuaTappingNode
|
||||
on_punch = function(luaEntity, puncher, time_from_last_punch, tool_capabilities, dir, damage)
|
||||
-- We simply trigger the event that the player hits the crafting node, bound to the work station with coordinates.
|
||||
Events:call(('craft_system:punch_tapping_node:%s:%s'):format(
|
||||
luaEntity._craft_name, luaEntity._stage_name), luaEntity._work_station_pos, puncher, luaEntity)
|
||||
|
||||
return false
|
||||
end,
|
||||
|
||||
---@param luaEntity CraftSystem.ImmersiveCraftNode.LuaTappingNode
|
||||
get_staticdata = function(luaEntity)
|
||||
---@type CraftSystem.ImmersiveCraftStage.TappingNode.InitParams?
|
||||
local params = {
|
||||
targetItem = luaEntity._item_name,
|
||||
craftName = luaEntity._craft_name,
|
||||
stageName = luaEntity._stage_name,
|
||||
WorkStationPos = luaEntity._work_station_pos
|
||||
}
|
||||
|
||||
return core.serialize(params)
|
||||
end,
|
||||
|
||||
---Sets the entity display of the item. If the item stack was not transferred, `self._item_name` is used.
|
||||
---@param luaEntity CraftSystem.ImmersiveCraftNode.LuaTappingNode
|
||||
---@param itemName ItemStackString?
|
||||
_set_item = function(luaEntity, itemName)
|
||||
-- We change the entity field so that the engine itself displays it as a given item.
|
||||
luaEntity.object:set_properties({
|
||||
wield_item = itemName or luaEntity._item_name,
|
||||
})
|
||||
end,
|
||||
}
|
||||
})
|
||||
|
||||
return tappingNode
|
||||
@@ -1,43 +0,0 @@
|
||||
local getInstance = Class.getInstance
|
||||
|
||||
---@alias CraftSystem.ImmersiveCraftStage.Type 'tapping'
|
||||
|
||||
---One of the stages of immersive crafting.
|
||||
---@class CraftSystem.ImmersiveCraftStage
|
||||
---@field name string
|
||||
---@field type CraftSystem.ImmersiveCraftStage.Type
|
||||
---@field craftName string
|
||||
---@field startHandler fun(self, pos:Position, player:Player)
|
||||
---@field processHandler fun(self, pos:Position, player:Player)
|
||||
---@field endHandler fun(self, pos:Position, player:Player)
|
||||
---@field abortHandler fun(self, pos:Position)
|
||||
---@field toString fun(self):string
|
||||
---@field nextStage string?
|
||||
---@field returnItems ItemStackString[]?
|
||||
local ImmersiveCraftStage = {}
|
||||
|
||||
---Definition table for the `CraftSystem.ImmersiveCraft`.
|
||||
---
|
||||
---**Only for EmmyLua.**
|
||||
---@class CraftSystem.ImmersiveCraftStageDef
|
||||
---@field name string
|
||||
---@field type CraftSystem.ImmersiveCraftStage.Type
|
||||
---@field craftName string?
|
||||
---@field nextStage string?
|
||||
---@field returnItems ItemStackString[]?
|
||||
|
||||
---@param def CraftSystem.ImmersiveCraftStageDef
|
||||
---@return CraftSystem.ImmersiveCraftStage
|
||||
function ImmersiveCraftStage:new(def)
|
||||
---@type CraftSystem.ImmersiveCraftStage
|
||||
local instance = getInstance(self, {})
|
||||
instance.name = def.name
|
||||
instance.type = def.type
|
||||
instance.craftName = def.craftName
|
||||
instance.nextStage = def.nextStage
|
||||
instance.returnItems = def.returnItems
|
||||
|
||||
return instance
|
||||
end
|
||||
|
||||
return ImmersiveCraftStage
|
||||
@@ -1,189 +0,0 @@
|
||||
local extend = Class.extend
|
||||
|
||||
local require = Mod.getInfo('smc__core__craft_system').require
|
||||
|
||||
---@type CraftSystem.ImmersiveCraftStage
|
||||
local ImmersiveCraftStage = require('CraftSystem.ImmersiveCraftStage')
|
||||
|
||||
---A crafting step that requires the player to hit a crafting node (entity) a certain number of times.
|
||||
---@class CraftSystem.ImmersiveCraftStage.TappingStage : CraftSystem.ImmersiveCraftStage
|
||||
---@field targetItem string
|
||||
---@field clicksNeed string
|
||||
---@field toolGroup string?
|
||||
---@field startHandler fun(self:CraftSystem.ImmersiveCraftStage.TappingStage, pos:MapVector, Player:Player)
|
||||
---@field processHandler fun(self:CraftSystem.ImmersiveCraftStage.TappingStage, pos:MapVector, Player:Player)
|
||||
---@field endHandler fun(self:CraftSystem.ImmersiveCraftStage.TappingStage, pos:MapVector, Player:Player)
|
||||
---@field toString fun(self:CraftSystem.ImmersiveCraftStage.TappingStage):string
|
||||
local TappingStage = extend(ImmersiveCraftStage, {})
|
||||
|
||||
---Definition table for the `CraftSystem.ImmersiveCraftStage.TappingStage`.
|
||||
---
|
||||
---**Only for EmmyLua.**
|
||||
---@class CraftSystem.ImmersiveCraftStage.TappingStageDef : CraftSystem.ImmersiveCraftStageDef
|
||||
---@field targetItem string
|
||||
---@field clicksNeed string
|
||||
---@field toolGroup string?
|
||||
|
||||
---Data table for transferring various time parameters between calls.
|
||||
---
|
||||
---**Only for EmmyLua.**
|
||||
---@class CraftSystem.ImmersiveCraftStage.TappingStageData
|
||||
---How many clicks were made by the player on the entity.
|
||||
---@field clickCount integer
|
||||
---Unique identifier of the entity (craft node).
|
||||
---@field entityGUID string
|
||||
|
||||
---@param def CraftSystem.ImmersiveCraftStage.TappingStageDef
|
||||
function TappingStage:new(def)
|
||||
---@type CraftSystem.ImmersiveCraftStage.TappingStage
|
||||
local instance = ImmersiveCraftStage:new(def)
|
||||
instance.targetItem = def.targetItem
|
||||
instance.clicksNeed = def.clicksNeed
|
||||
instance.toolGroup = def.toolGroup
|
||||
|
||||
-- Registering the crafting stage start handler.
|
||||
instance.startHandler = function(tappingStage , pos, player)
|
||||
local entityPos = vector.new(pos) + vector.new(0,0.875,0)
|
||||
|
||||
---@class CraftSystem.ImmersiveCraftStage.TappingNode.InitParams
|
||||
local params = {
|
||||
targetItem = tappingStage.targetItem,
|
||||
craftName = tappingStage.craftName,
|
||||
stageName = tappingStage.name,
|
||||
WorkStationPos = pos,
|
||||
}
|
||||
|
||||
local obj = core.add_entity(entityPos, 'craft_system:tapping_node', core.serialize(params))
|
||||
|
||||
if obj == nil then
|
||||
return
|
||||
end
|
||||
|
||||
---@type CraftSystem.ImmersiveCraftStage.TappingStageData
|
||||
local stageData = {
|
||||
clickCount = 0,
|
||||
entityGUID = obj:get_guid()
|
||||
}
|
||||
|
||||
--@type ImmersiveWorkStation.MetaData
|
||||
local meta = core.get_meta(pos)
|
||||
meta:set_string('stage_data', core.serialize(stageData))
|
||||
end
|
||||
|
||||
-- Registering the crafting stage process handler.
|
||||
-- Called when a player clicks on a crafting node (entity).
|
||||
instance.processHandler = function(tappingStage, pos, player)
|
||||
---@type ImmersiveWorkStation.MetaData
|
||||
local meta = core.get_meta(pos)
|
||||
---@type CraftSystem.ImmersiveCraftStage.TappingStageData?
|
||||
local stageData = core.deserialize(meta:get_string('stage_data'))
|
||||
assert(stageData ~= nil)
|
||||
|
||||
local clickCount = stageData.clickCount
|
||||
clickCount = clickCount + 1
|
||||
|
||||
if clickCount >= tappingStage.clicksNeed then
|
||||
tappingStage:endHandler(pos, player)
|
||||
else
|
||||
stageData.clickCount = clickCount
|
||||
meta:set_string('stage_data', core.serialize(stageData))
|
||||
end
|
||||
end
|
||||
|
||||
-- Registering the crafting stage end handler.
|
||||
instance.endHandler = function(tappingStage, pos, player)
|
||||
---@type ImmersiveWorkStation.MetaData
|
||||
local meta = core.get_meta(pos)
|
||||
---@type CraftSystem.ImmersiveCraftStage.TappingStageData?
|
||||
local stageData = core.deserialize(meta:get_string('stage_data'))
|
||||
assert(stageData ~= nil)
|
||||
|
||||
|
||||
local entity = Smc.getObjectByGUID(stageData.entityGUID)
|
||||
assert(entity ~= nil, 'The entity for immersive crafting is nil.')
|
||||
|
||||
entity:remove()
|
||||
|
||||
Events:call('craft_system:next_immersive_stage:'..tappingStage.craftName, tappingStage, pos, player)
|
||||
end
|
||||
|
||||
-- Registering the aborting the crafting process handler.
|
||||
---@param tappingStage CraftSystem.ImmersiveCraftStage.TappingStage
|
||||
instance.abortHandler = function(tappingStage, pos)
|
||||
---@type ImmersiveWorkStation.MetaData
|
||||
local meta = core.get_meta(pos)
|
||||
---@type CraftSystem.ImmersiveCraftStage.TappingStageData?
|
||||
local stageData = core.deserialize(meta:get_string('stage_data'))
|
||||
assert(stageData ~= nil)
|
||||
local amount = meta:get_float('craft_amount')
|
||||
assert(amount ~= 0)
|
||||
|
||||
---@type CraftSystem.ImmersiveCraftStage.TappingStageData?
|
||||
local stageData = stageData
|
||||
assert(stageData ~= nil, 'Immersive stage data is empty.')
|
||||
|
||||
local entity = Smc.getObjectByGUID(stageData.entityGUID)
|
||||
assert(entity ~= nil, 'The entity for immersive crafting is nil.')
|
||||
|
||||
entity:remove()
|
||||
|
||||
-- We drop the item as it was before processing.
|
||||
local dropPos = vector.new(pos)+vector.new(0, 0.9,0)
|
||||
for i=1, amount do
|
||||
core.item_drop(ItemStack(tappingStage.targetItem), nil, dropPos)
|
||||
end
|
||||
end
|
||||
|
||||
-- Returns a human-readable description of the crafting stage.
|
||||
instance.toString = function(tappingStage)
|
||||
local stageDesc
|
||||
if tappingStage.toolGroup ~= nil then
|
||||
stageDesc = ('Tapping x%s tool with a group "%s"'):format(tappingStage.clicksNeed, tappingStage.toolGroup)
|
||||
else
|
||||
stageDesc = ('Tapping x%s'):format(tappingStage.clicksNeed)
|
||||
end
|
||||
|
||||
return stageDesc
|
||||
end
|
||||
|
||||
-- Subscribe to an event that means the player hit the entity.
|
||||
Events:subscribe(('craft_system:punch_tapping_node:%s:%s'):format(instance.craftName, instance.name),
|
||||
---@param craftNode LuaEntity
|
||||
---@param player Player
|
||||
function(eventName, pos, player, craftNode)
|
||||
local toolDef = player:get_wielded_item():get_definition()
|
||||
|
||||
-- If a crafting stage requires a specific tool group and he doesn't have it then we don't do anything.
|
||||
if instance.toolGroup and (not toolDef.groups or not toolDef.groups[instance.toolGroup]) then
|
||||
return
|
||||
end
|
||||
|
||||
-- DRAFT START:
|
||||
-- Creating particles
|
||||
for i=0, 10 do
|
||||
core.add_particle({
|
||||
pos = vector.new(pos)+vector.new(0,0.5,0),
|
||||
velocity = {x=math.random(-1,1), y=4, z=math.random(-1,1)},
|
||||
acceleration = {x=0, y=-9.8, z=0},
|
||||
expirationtime = 2,
|
||||
collision_removal = true,
|
||||
node = {name=instance.targetItem}
|
||||
})
|
||||
end
|
||||
|
||||
-- Making the entity shake (silly method :P).
|
||||
craftNode.object:set_rotation(vector.new(0.01,0.1,0.01))
|
||||
core.after(0.1, function() craftNode.object:set_rotation(vector.new(-0.01,-0.1,-0.01))end)
|
||||
core.after(0.2, function() craftNode.object:set_rotation(vector.new(0,0,0))end)
|
||||
-- DRAFT END
|
||||
|
||||
instance:processHandler(pos, player)
|
||||
end)
|
||||
|
||||
return instance
|
||||
end
|
||||
|
||||
-- Registering an entity for immersive tapping crafting.
|
||||
require('CraftSystem.ImmersiveCraftNode.tappingNode')
|
||||
|
||||
return TappingStage
|
||||
@@ -1,30 +0,0 @@
|
||||
local getInstance, extend = Class.getInstance, Class.extend
|
||||
|
||||
local modInfo = Mod.getInfo('smc__core__craft_system')
|
||||
local require = modInfo.require
|
||||
|
||||
---@type CraftSystem.BaseCraft
|
||||
local BaseCraft = require('CraftSystem.BaseCraft')
|
||||
|
||||
---@class CraftSystem.PrimitiveCraft : CraftSystem.BaseCraft
|
||||
---@field returnItems ItemStackString[]?
|
||||
local PrimitiveCraft = BaseCraft:extend({})
|
||||
|
||||
---Definition table for the `CraftSystem.PrimitiveCraft`.
|
||||
---
|
||||
---**Only for EmmyLua.**
|
||||
---@class CraftSystem.PrimitiveCraftDef : CraftSystem.BaseCraftDef
|
||||
---@field returnItems ItemStackString[]?
|
||||
|
||||
---@param name string
|
||||
---@param def CraftSystem.PrimitiveCraftDef
|
||||
---@return CraftSystem.PrimitiveCraft
|
||||
function PrimitiveCraft:new(name, def)
|
||||
---@type CraftSystem.PrimitiveCraft
|
||||
local instance = self:getInstance(BaseCraft:new(name, def))
|
||||
instance.returnItems = def.returnItems
|
||||
|
||||
return instance
|
||||
end
|
||||
|
||||
return PrimitiveCraft
|
||||
@@ -1,92 +0,0 @@
|
||||
local extend = Class.extend
|
||||
|
||||
local tableInsert, tableSort, tableJoin = table.insert, table.sort, table.join
|
||||
|
||||
local modInfo = Mod.getInfo('smc__core__craft_system')
|
||||
local require = modInfo.require
|
||||
|
||||
---@type CraftSystem.BaseCraftHandler
|
||||
local BaseCraftHandler = require('CraftSystem.BaseCraftHandler')
|
||||
|
||||
---@type CraftSystem.PrimitiveCraft
|
||||
local PrimitiveCraft = require('CraftSystem.PrimitiveCraft')
|
||||
|
||||
---A primitive crafting processor that doesn't require much interaction and provides
|
||||
---simple crafting based on a recipe-result scheme.
|
||||
---@class CraftSystem.PrimitiveCraftHandler : CraftSystem.BaseCraftHandler
|
||||
---@field defaultCraftDef CraftSystem.PrimitiveCraftDef
|
||||
---
|
||||
---@field craftsByGroup table<CraftSystem.CraftGroup, CraftSystem.PrimitiveCraft[]>
|
||||
---@field groupedCrafts (CraftSystem.PrimitiveCraft[]|CraftSystem.PrimitiveCraft)[]
|
||||
---
|
||||
---@field new fun(self:CraftSystem.PrimitiveCraftHandler, baseType:CraftSystem.BaseCraftType, type:CraftSystem.PrimitiveCraftType, def:CraftSystem.PrimitiveCraftHandlerDef):CraftSystem.PrimitiveCraftHandler
|
||||
---@field getCraftByName fun(self, craftName:string):CraftSystem.PrimitiveCraft
|
||||
---@field getCraftsByGroup fun(self, craftGroup:string):CraftSystem.PrimitiveCraft[]
|
||||
---@field getLearnedCrafts fun(self, playerName:string):(CraftSystem.PrimitiveCraft[]|CraftSystem.PrimitiveCraft)[]
|
||||
local PrimitiveCraftHandler = BaseCraftHandler:extend({})
|
||||
|
||||
---@class CraftSystem.PrimitiveCraftHandlerDef : CraftSystem.BaseCraftHandlerDef
|
||||
---@field defaultCraftDef CraftSystem.PrimitiveCraftDef?
|
||||
|
||||
---Register a primitive craft that does not require special interaction.
|
||||
---@param craftName string
|
||||
---@param def CraftSystem.PrimitiveCraftDef
|
||||
function PrimitiveCraftHandler:registerCraft(craftName, def)
|
||||
assert(self.craftsByName[craftName] == nil, ('A craft named `%s` already exists.'):format(
|
||||
craftName))
|
||||
|
||||
local def = table.merge(def, self.defaultCraftDef)
|
||||
|
||||
local group = 'craft_group:' .. (def.group or 'UNDEFINED')
|
||||
def.group = group
|
||||
|
||||
local craft = PrimitiveCraft:new(craftName, def)
|
||||
|
||||
if self.craftsByGroup[group] == nil then
|
||||
self.craftsByGroup[group] = {}
|
||||
end
|
||||
|
||||
self.craftsByName[craftName] = craft
|
||||
tableInsert(self.craftsByGroup[group], craft)
|
||||
tableInsert(self.craftsList, craft)
|
||||
end
|
||||
|
||||
---Adds alternative recipes to the craft with the specified name.
|
||||
---
|
||||
---If a craft with the specified name does not exist, an error will call.
|
||||
---@param craftName string
|
||||
---@param recipes CraftSystem.CraftRecipe[]
|
||||
function PrimitiveCraftHandler:registerAlternativeRecipes(craftName, recipes)
|
||||
local craft = PrimitiveCraftHandler:getCraftByName(craftName)
|
||||
|
||||
craft.altRecipes = tableJoin(craft.altRecipes or {}, recipes)
|
||||
end
|
||||
|
||||
-- Sort the list of crafts in alphabetical order by product name and combine crafts into groups.
|
||||
-- Provides a convenient list of crafting items in the player's inventory.
|
||||
core.register_on_mods_loaded(function()
|
||||
for groupName, crafts in pairs(PrimitiveCraftHandler.craftsByGroup) do
|
||||
tableSort(crafts, function(a, b)
|
||||
if a.output < b.output then
|
||||
return true
|
||||
end
|
||||
end)
|
||||
|
||||
if groupName ~= 'craft_group:UNDEFINED' then
|
||||
tableInsert(PrimitiveCraftHandler.groupedCrafts, crafts)
|
||||
else
|
||||
PrimitiveCraftHandler.groupedCrafts = tableJoin(PrimitiveCraftHandler.groupedCrafts, crafts)
|
||||
end
|
||||
end
|
||||
|
||||
tableSort(PrimitiveCraftHandler.groupedCrafts, function(a, b)
|
||||
local outputA = (a[1] and a[1].output) or a.output
|
||||
local outputB = (b[1] and b[1].output) or b.output
|
||||
|
||||
if outputA < outputB then
|
||||
return true
|
||||
end
|
||||
end)
|
||||
end)
|
||||
|
||||
return PrimitiveCraftHandler
|
||||
@@ -1,41 +0,0 @@
|
||||
local getInstance, extend = Class.getInstance, Class.extend
|
||||
|
||||
local modInfo = Mod.getInfo('smc__core__craft_system')
|
||||
local require = modInfo.require
|
||||
|
||||
---@type CraftSystem.BaseCraft
|
||||
local BaseCraft = require('CraftSystem.BaseCraft')
|
||||
|
||||
---@class CraftSystem.ProcessingCraft : CraftSystem.BaseCraft
|
||||
---@field recipe CraftSystem.CraftRecipe
|
||||
---@field time number
|
||||
---@field startHandler fun()
|
||||
---@field processHandler fun()
|
||||
---@field endHandler fun()
|
||||
local ProcessingCraft = BaseCraft:extend({})
|
||||
|
||||
---Definition table for the `CraftSystem.ProcessingCraft`.
|
||||
---
|
||||
---**Only for EmmyLua.**
|
||||
---@class CraftSystem.ProcessingCraftDef : CraftSystem.BaseCraftDef
|
||||
---@field recipe CraftSystem.CraftRecipe
|
||||
---@field time number
|
||||
---@field startHandler fun()?
|
||||
---@field processHandler fun()?
|
||||
---@field endHandler fun()?
|
||||
|
||||
---@param name string
|
||||
---@param def CraftSystem.ProcessingCraftDef
|
||||
---@return CraftSystem.ProcessingCraft
|
||||
function ProcessingCraft:new(name, def)
|
||||
---@type CraftSystem.ProcessingCraft
|
||||
local instance = self:getInstance(BaseCraft:new(name, def))
|
||||
instance.time = def.time
|
||||
instance.startHandler = def.startHandler or function() end
|
||||
instance.processHandler = def.processHandler or function() end
|
||||
instance.endHandler = def.endHandler or function() end
|
||||
|
||||
return instance
|
||||
end
|
||||
|
||||
return ProcessingCraft
|
||||
@@ -1,89 +0,0 @@
|
||||
local HASH_SEPARATOR = ','
|
||||
|
||||
local tableInsert, tableCopy, tableSort, tableConcat, tableIsEmpty = table.insert, table.copy, table.sort, table.concat, table.is_empty
|
||||
|
||||
local modInfo = Mod.getInfo('smc__core__craft_system')
|
||||
local require = modInfo.require
|
||||
|
||||
---@type CraftSystem.BaseCraftHandler
|
||||
local BaseCraftHandler = require('CraftSystem.BaseCraftHandler')
|
||||
|
||||
---@type CraftSystem.ProcessingCraft
|
||||
local ProcessingCraft = require('CraftSystem.ProcessingCraft')
|
||||
|
||||
---A primitive crafting processor that doesn't require much interaction and provides
|
||||
---simple crafting based on a recipe-result scheme.
|
||||
---@class CraftSystem.ProcessingCraftHandler : CraftSystem.BaseCraftHandler
|
||||
---@field defaultCraftDef CraftSystem.ProcessingCraftDef
|
||||
---
|
||||
---@field craftsByHash table<string, CraftSystem.ProcessingCraft>
|
||||
---
|
||||
---@field new fun(self:CraftSystem.ProcessingCraftHandler, baseType:CraftSystem.BaseCraftType, type:CraftSystem.ProcessingCraftType, def:CraftSystem.ProcessingCraftHandlerDef):CraftSystem.ProcessingCraftHandler
|
||||
---@field getCraftByName fun(self, craftName:string):CraftSystem.ProcessingCraft
|
||||
---@field getCraftsByGroup fun(self, craftGroup:string):CraftSystem.ProcessingCraft[]
|
||||
---@field getLearnedCrafts fun(self, playerName:string):(CraftSystem.ProcessingCraft[]|CraftSystem.ProcessingCraft)[]
|
||||
local ProcessingCraftHandler = BaseCraftHandler:extend({
|
||||
craftsByHash = {}
|
||||
})
|
||||
|
||||
---@class CraftSystem.ProcessingCraftHandlerDef : CraftSystem.BaseCraftHandlerDef
|
||||
---@field defaultCraftDef CraftSystem.ProcessingCraftDef?
|
||||
|
||||
---@param recipe CraftSystem.CraftRecipe
|
||||
local function getCraftHash(recipe)
|
||||
recipe = tableCopy(recipe)
|
||||
|
||||
tableSort(recipe)
|
||||
return tableConcat(recipe, HASH_SEPARATOR)
|
||||
end
|
||||
|
||||
---Register a primitive craft that does not require special interaction.
|
||||
---@param craftName string
|
||||
---@param def CraftSystem.ProcessingCraftDef
|
||||
function ProcessingCraftHandler:registerCraft(craftName, def)
|
||||
assert(self.craftsByName[craftName] == nil, ('A craft named `%s` already exists.'):format(
|
||||
craftName))
|
||||
|
||||
local def = table.merge(def, self.defaultCraftDef)
|
||||
|
||||
local group = 'craft_group:' .. (def.group or 'UNDEFINED')
|
||||
def.group = group
|
||||
|
||||
local craft = ProcessingCraft:new(craftName, def)
|
||||
|
||||
if self.craftsByGroup[group] == nil then
|
||||
self.craftsByGroup[group] = {}
|
||||
end
|
||||
|
||||
local craftHash = getCraftHash(craft.recipe)
|
||||
assert(self.craftsByHash[craftHash] == nil, 'A craft with this recipe already exists.')
|
||||
|
||||
self.craftsByName[craftName] = craft
|
||||
tableInsert(self.craftsByGroup[group], craft)
|
||||
tableInsert(self.craftsList, craft)
|
||||
self.craftsByHash[craftHash] = craft
|
||||
end
|
||||
|
||||
---@param input ItemStack[]
|
||||
---@return CraftSystem.ProcessingCraft?
|
||||
function ProcessingCraftHandler:getCraftByRecipe(input)
|
||||
local recipe = {}
|
||||
for _, item in ipairs(input) do
|
||||
if not item:is_empty() then
|
||||
tableInsert(recipe, item:get_name())
|
||||
end
|
||||
end
|
||||
|
||||
if tableIsEmpty(recipe) then
|
||||
return nil
|
||||
end
|
||||
|
||||
-- TODO: добавить поиск по группам крафтов
|
||||
|
||||
local craftHash = getCraftHash(recipe)
|
||||
local craft = self.craftsByHash[craftHash]
|
||||
|
||||
return craft
|
||||
end
|
||||
|
||||
return ProcessingCraftHandler
|
||||
@@ -1,4 +0,0 @@
|
||||
local modInfo = Mod.getInfo('smc__core__creature')
|
||||
local require = modInfo.require
|
||||
|
||||
return require('Creature')
|
||||
@@ -1 +0,0 @@
|
||||
name = smc__core__creature
|
||||
@@ -1,109 +0,0 @@
|
||||
local getInstance, extend = Class.getInstance, Class.extend
|
||||
|
||||
local tableCopy, tableMerge = table.copy, table.merge
|
||||
|
||||
---@class Creature
|
||||
---@field entityDef Creature.CreatureDefinition
|
||||
---@field luantiDef EntityDefinition
|
||||
---@field defaultDef Creature.CreatureDefinition
|
||||
local Creature = {
|
||||
defaultDef = {
|
||||
settings = {
|
||||
_name = '',
|
||||
_add_mod_name = true,
|
||||
initial_properties = {},
|
||||
},
|
||||
callbacks = {}
|
||||
}
|
||||
}
|
||||
|
||||
---@param entityDef Creature.CreatureDefinition
|
||||
---@return EntityDefinition
|
||||
local function entityDefToLuantiDef(entityDef)
|
||||
entityDef = tableCopy(entityDef)
|
||||
local s = entityDef.settings
|
||||
local c = entityDef.callbacks or {}
|
||||
|
||||
---@type EntityDefinition
|
||||
local luantiDef = tableMerge(s, c)
|
||||
|
||||
return luantiDef
|
||||
end
|
||||
|
||||
---@param entityDef Creature.CreatureDefinition
|
||||
---@return Creature
|
||||
function Creature:new(entityDef)
|
||||
-- Adding default parameters.
|
||||
---@type Creature.CreatureDefinition
|
||||
entityDef = tableMerge(entityDef, self.defaultDef, true)
|
||||
|
||||
-- The callback table may not be specified.
|
||||
if entityDef.callbacks == nil then
|
||||
---@type Creature.Callbacks
|
||||
entityDef.callbacks = {}
|
||||
end
|
||||
|
||||
local s = entityDef.settings
|
||||
local c = entityDef.callbacks
|
||||
|
||||
-- Add the short mod name prefix to the entity name.
|
||||
if s._add_mod_name then
|
||||
s._name = Mod.getInfo().shortName .. ':' .. s._name
|
||||
end
|
||||
|
||||
local onActivate = c.on_activate or function() end
|
||||
|
||||
-- We rewrite the entity initialization function so that custom fields
|
||||
-- can be passed to it directly via `core.add_entity(pos, name, [staticdata])`.
|
||||
c.on_activate = function(luaEntity, staticdata, dtime)
|
||||
local initCustomFields = {}
|
||||
|
||||
if staticdata and staticdata ~= '' then
|
||||
initCustomFields = core.deserialize(staticdata) or {}
|
||||
end
|
||||
|
||||
-- We reset the fields that should not be overwritten.
|
||||
initCustomFields.name = nil
|
||||
initCustomFields.object = nil
|
||||
|
||||
---@type LuaEntity
|
||||
self = tableMerge(self, initCustomFields)
|
||||
|
||||
-- If an initialization callback was specified for the entity, then we call it.
|
||||
if c.on_activate ~= nil then
|
||||
onActivate(luaEntity, staticdata, dtime)
|
||||
end
|
||||
end
|
||||
|
||||
---@type Creature
|
||||
local instance = getInstance(self, {})
|
||||
|
||||
local luantiDef = entityDefToLuantiDef(entityDef)
|
||||
|
||||
instance.entityDef = entityDef
|
||||
instance.luantiDef = luantiDef
|
||||
|
||||
core.register_entity(':'..s._name, luantiDef)
|
||||
|
||||
return instance
|
||||
end
|
||||
|
||||
---Allows you to create a child class of an entity by specifying
|
||||
---default parameters that will be added to the entity's parameters
|
||||
---when an instance is received.
|
||||
---@param defaultDef Creature.CreatureDefinition
|
||||
---@return Creature
|
||||
function Creature:getExtended(defaultDef)
|
||||
-- Adding default parameters.
|
||||
---@type Creature.CreatureDefinition
|
||||
defaultDef = tableMerge(self.defaultDef, defaultDef)
|
||||
|
||||
---@type Creature
|
||||
local ChildClass = extend(self, {
|
||||
defaultDef = defaultDef,
|
||||
})
|
||||
|
||||
return ChildClass
|
||||
end
|
||||
|
||||
return Creature
|
||||
@@ -1,72 +0,0 @@
|
||||
---@class Creature.Callbacks
|
||||
local Callbacks = {}
|
||||
|
||||
---Called when the object is instantiated.
|
||||
--- * `dtime_s` is the time passed since the object was unloaded,
|
||||
---which can be used for updating the entity state.
|
||||
---@type fun(self:LuaEntity, staticdata:string, dtime_s:number)?
|
||||
Callbacks.on_activate = nil
|
||||
|
||||
---Called when the object is about to get removed or unloaded.
|
||||
--- * `removal`: boolean indicating whether the object is about to get removed.
|
||||
--- Calling `object:remove()` on an active object will call this with `removal=true`.
|
||||
--- The mapblock the entity resides in being unloaded will call this with `removal=false`.
|
||||
---
|
||||
---Note that this won't be called if the object hasn't been activated in the first place.
|
||||
---In particular, `core.clear_objects({mode = "full"})` won't call this,
|
||||
---whereas `core.clear_objects({mode = "quick"})` might call this.
|
||||
---@type fun(self:LuaEntity, removal:boolean)?
|
||||
Callbacks.on_deactivate = nil
|
||||
|
||||
---Called on every server tick, after movement and collision processing.
|
||||
--- * `dtime`: elapsed time since last call
|
||||
--- * `s`: table with collision info (only available if `physical=true`)
|
||||
---@type fun(self:LuaEntity, dtime:number, moveresult:table)? -- TODO: дописать более точный тип moveresult
|
||||
Callbacks.on_step = nil
|
||||
|
||||
---Called when somebody punches the object.
|
||||
---Note that you probably want to handle most punches using the automatic armor group system.
|
||||
--- * `puncher`: an `ObjectRef `(can be `nil`)
|
||||
--- * `time_from_last_punch`: Meant for disallowing spamming of clicks (can be `nil`).
|
||||
--- * `tool_capabilities`: capability table of used item
|
||||
--- * `dir`: unit vector of direction of punch. Always defined. Points from the puncher to the punched.
|
||||
--- * `damage``: damage that will be done to entity.
|
||||
---
|
||||
---Can return `true` to prevent the default damage mechanism.
|
||||
---@type (fun(self:LuaEntity, puncher:ObjectRef|Player|nil, time_from_last_punch:number|nil, tool_capabilities:table|nil, dir:vector, damage:number):boolean)? -- TODO: дописать более точный тип для tool_capabilities
|
||||
Callbacks.on_punch = nil
|
||||
|
||||
---Called when the object dies.
|
||||
--- * `killer`: an `ObjectRef` (can be `nil`)
|
||||
---@type fun(self:LuaEntity, killer:ObjectRef|Player|nil)?
|
||||
Callbacks.on_death = nil
|
||||
|
||||
---Called when `clicker` pressed the 'place/use' key while
|
||||
---pointing to the object (not necessarily an actual rightclick)
|
||||
--- * `clicker`: an `ObjectRef` (may or may not be a player)
|
||||
---@type fun(self:LuaEntity, clicker:ObjectRef|Player)?
|
||||
Callbacks.on_rightclick = nil
|
||||
|
||||
---Called after another object is attached to this object.
|
||||
--- * `child`: an `ObjectRef` of the child
|
||||
---@type fun(self:LuaEntity, child:ObjectRef)?
|
||||
Callbacks.on_attach_child = nil
|
||||
|
||||
---Called after another object has detached from this object.
|
||||
--- * `child`: an `ObjectRef` of the child
|
||||
---@type fun(self:LuaEntity, child:ObjectRef)?
|
||||
Callbacks.on_detach_child = nil
|
||||
|
||||
---Called after detaching from another object.
|
||||
--- * `parent`: an ObjectRef from where it got detached
|
||||
---
|
||||
---**Note**: this is also called before removal from the world.
|
||||
---@type fun(self:LuaEntity, parent)?
|
||||
Callbacks.on_detach = nil
|
||||
|
||||
---Should return a string that will be passed to `on_activate` when the object
|
||||
---is instantiated the next time.
|
||||
---@type (fun(self:LuaEntity):string)?
|
||||
Callbacks.get_staticdata = nil
|
||||
|
||||
return Callbacks
|
||||
@@ -1,6 +0,0 @@
|
||||
---@class Creature.CreatureDefinition
|
||||
---@field settings Creature.Settings
|
||||
---@field callbacks Creature.Callbacks?
|
||||
local CreatureDefinition = {}
|
||||
|
||||
return CreatureDefinition
|
||||
@@ -1,9 +0,0 @@
|
||||
---A class that extends `LuaEntity` to annotate custom fields.
|
||||
---
|
||||
---**Only for EmmyLua.**
|
||||
---@class Creature.LuaEntity : LuaEntity
|
||||
---@field _name string
|
||||
---@field _add_mod_name boolean
|
||||
local LuaEntity = {}
|
||||
|
||||
return LuaEntity
|
||||
@@ -1,14 +0,0 @@
|
||||
---@class Creature.Settings
|
||||
local Settings = {}
|
||||
|
||||
---Registration name for the entity. Must be unique.
|
||||
---@type string
|
||||
Settings._name = nil
|
||||
|
||||
---Whether to add the mod name to the settings._name. Default: `true`
|
||||
Settings._add_mod_name = nil
|
||||
|
||||
---@type ObjectProperties
|
||||
Settings.initial_properties = nil
|
||||
|
||||
return Settings
|
||||
0
mods/CORE/Entity/init.lua
Normal file
0
mods/CORE/Entity/init.lua
Normal file
1
mods/CORE/Entity/mod.conf
Normal file
1
mods/CORE/Entity/mod.conf
Normal file
@@ -0,0 +1 @@
|
||||
name = smc__core__entity
|
||||
@@ -197,30 +197,12 @@ end
|
||||
---@return Formspec
|
||||
function Formspec:list(inventoryLocation, listName, x, y, w, h, startingItemIndex)
|
||||
local element = ('list[%s;%s;%s,%s;%s,%s;%s]'):format(
|
||||
inventoryLocation, listName, x, y, w, h, startingItemIndex or '')
|
||||
inventoryLocation, listName, x, y, w, h,startingItemIndex or '')
|
||||
|
||||
self:addElement(element)
|
||||
return self
|
||||
end
|
||||
|
||||
---A wrapper around `Formspec:list` that allows access to the inventory of a node,
|
||||
---specified by the coordinates of its position in the world.
|
||||
---@param nodePos MapVector
|
||||
---@param listName string
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param w number Are in inventory slots, not in coordinates.
|
||||
---@param h number Are in inventory slots, not in coordinates.
|
||||
---@param startingItemIndex number? The index of the first (upper-left) item to draw. Indices start at `0`. Default is `0`.
|
||||
---@return Formspec
|
||||
function Formspec:listNodeMetaLocation(nodePos, listName, x, y, w, h, startingItemIndex)
|
||||
local inventoryLocation = ('nodemeta:%s,%s,%s'):format(nodePos.x, nodePos.y, nodePos.z)
|
||||
|
||||
self:list(inventoryLocation, listName, x, y, w, h, startingItemIndex)
|
||||
|
||||
return self
|
||||
end
|
||||
|
||||
---Creates and appends a list of `listring[<inventory location>;<list name>]` items based on the passed inventory list.
|
||||
---
|
||||
---**Elements:** `listring[<inventory location>;<list name>]` or `listring[]`
|
||||
@@ -314,7 +296,7 @@ end
|
||||
---@param w number
|
||||
---@param h number
|
||||
---@param textureName string
|
||||
---@param middle string? Makes the image render in 9-sliced mode and defines the middle rect.
|
||||
---@param middle boolean? Makes the image render in 9-sliced mode and defines the middle rect.
|
||||
---@return Formspec
|
||||
function Formspec:image(x, y, w, h, textureName, middle)
|
||||
local element = ('image[%s,%s;%s,%s;%s;%s]'):format(
|
||||
@@ -459,7 +441,7 @@ end
|
||||
--- * All numbers in middle are integers.
|
||||
---@return Formspec
|
||||
function Formspec:background9(x, y, w, h, textureName, autoClip, middle)
|
||||
local element = ('background9[%s,%s;%s,%s;%s;%s;%s]'):format(
|
||||
local element = ('background9[%s,%s;%s,%s;%s;%s]'):format(
|
||||
x, y, w, h, textureName, autoClip, middle)
|
||||
|
||||
self:addElement(element)
|
||||
@@ -509,7 +491,7 @@ end
|
||||
---@return Formspec
|
||||
function Formspec:field(x, y, w, h, name, label, default)
|
||||
local element = ('field[%s,%s;%s,%s;%s;%s;%s]'):format(
|
||||
x, y, w, h, name, label or '', core.formspec_escape(default) or '')
|
||||
x, y, w, h, name, label or '', default or '')
|
||||
|
||||
self:addElement(element)
|
||||
return self
|
||||
@@ -563,7 +545,7 @@ end
|
||||
--- Defaults to true when not specified (i.e. no tag for a field).
|
||||
---@return Formspec
|
||||
function Formspec:fieldCloseOnEnter(name, closeOnEnter)
|
||||
local element = ('field_close_on_enter[%s;%s]'):format(
|
||||
local element = ('field_enter_after_edit[%s;%s]'):format(
|
||||
name, closeOnEnter or false)
|
||||
|
||||
self:addElement(element)
|
||||
@@ -590,7 +572,7 @@ end
|
||||
---@return Formspec
|
||||
function Formspec:textArea(x, y, w, h, name, label, default)
|
||||
local element = ('textarea[%s,%s;%s,%s;%s;%s;%s]'):format(
|
||||
x, y, w, h, name or '', label or '', core.formspec_escape(default) or '')
|
||||
x, y, w, h, name or '', label or '', default or '')
|
||||
|
||||
self:addElement(element)
|
||||
return self
|
||||
@@ -610,7 +592,7 @@ end
|
||||
---@return Formspec
|
||||
function Formspec:label(x, y, label)
|
||||
local element = ('label[%s,%s;%s]'):format(
|
||||
x, y, core.formspec_escape(label))
|
||||
x, y, label)
|
||||
|
||||
self:addElement(element)
|
||||
return self
|
||||
@@ -630,7 +612,7 @@ end
|
||||
---@return Formspec
|
||||
function Formspec:areaLabel(x, y, w, h, label)
|
||||
local element = ('label[%s,%s;%s,%s;%s]'):format(
|
||||
x, y, w, h, core.formspec_escape(label))
|
||||
x, y, w, h, label)
|
||||
|
||||
self:addElement(element)
|
||||
return self
|
||||
@@ -664,7 +646,7 @@ end
|
||||
---@return Formspec
|
||||
function Formspec:vertlabel(x, y, label)
|
||||
local element = ('vertlabel[%s,%s;%s]'):format(
|
||||
x, y, core.formspec_escape(label))
|
||||
x, y, label)
|
||||
|
||||
self:addElement(element)
|
||||
return self
|
||||
@@ -718,7 +700,7 @@ end
|
||||
---
|
||||
---**Elements:** `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]` or
|
||||
---`image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
|
||||
---@overload fun(x:number, y:number, w:number, h:number, textureName:string, name:string, label:string?):Formspec
|
||||
---@overload fun(x:number, y:number, w:number, h:number, textureName:string, name:string, label:string)
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param w number
|
||||
@@ -726,7 +708,7 @@ end
|
||||
---@param textureName string Is the filename of an image.
|
||||
---@param name string
|
||||
---@param label string?
|
||||
---@param pressedTextureName string? Is the filename of an image on pressed state.
|
||||
---@param pressedTextureName string Is the filename of an image on pressed state.
|
||||
---@param noclip boolean? Means the image button doesn't need to be within specified formsize. Default: `true`
|
||||
---@param drawborder boolean? Draw button border or not. Default `false`
|
||||
---@return Formspec
|
||||
@@ -738,7 +720,7 @@ function Formspec:imageButton(x, y, w, h, textureName, name, label, pressedTextu
|
||||
x, y, w, h, textureName, name, label or '')
|
||||
else
|
||||
element = ('image_button[%s,%s;%s,%s;%s;%s;%s;%s;%s;%s]'):format(
|
||||
x, y, w, h, textureName, name, label or '', noclip or true, drawborder or false, pressedTextureName)
|
||||
x, y, w, h, textureName, name, label or '', pressedTextureName, noclip or true, drawborder or false)
|
||||
end
|
||||
|
||||
self:addElement(element)
|
||||
|
||||
@@ -1,4 +0,0 @@
|
||||
local modInfo = Mod.getInfo('smc__core__immersive_work_station')
|
||||
local require = modInfo.require
|
||||
|
||||
return require('ImmersiveWorkStation')
|
||||
@@ -1,2 +0,0 @@
|
||||
name = smc__core__immersive_work_station
|
||||
depends = smc__core__craft_system, smc__core__node, smc__ui__work_station
|
||||
@@ -1,218 +0,0 @@
|
||||
local getInstance = Class.getInstance
|
||||
|
||||
local CraftSystem = Smc.requireCraftSystem()
|
||||
|
||||
local PlayerInventoryUI = Smc.requirePlayerInventoryUI()
|
||||
|
||||
local Node = Smc.requireNode()
|
||||
|
||||
-- Default settings that a work station node should have.
|
||||
local ImmersiveWorkStationNode = Node:getExtended({
|
||||
settings = {
|
||||
name = '',
|
||||
drawtype = 'normal',
|
||||
paramtype = 'light',
|
||||
groups = { immersive_station = 1, dig_immediate = 2 }
|
||||
}
|
||||
})
|
||||
|
||||
---A work station (node) that enables player interaction
|
||||
---with the immersive crafting mechanics.
|
||||
---@class ImmersiveWorkStation
|
||||
---@field name string
|
||||
---@field craftType CraftSystem.ImmersiveCraftType
|
||||
---@field handler CraftSystem.ImmersiveCraftHandler
|
||||
---@field tab PlayerInventoryUI.getTabFunc
|
||||
local ImmersiveWorkStation = {}
|
||||
|
||||
---Definition table for the `ImmersiveWorkStation`.
|
||||
---
|
||||
---**Only for EmmyLua.**
|
||||
---@class ImmersiveWorkStationDef
|
||||
---@field craftType CraftSystem.ImmersiveCraftType
|
||||
---@field tab PlayerInventoryUI.getTabFunc
|
||||
|
||||
---@param name string
|
||||
---@param def ImmersiveWorkStationDef
|
||||
---@param nodeDef Node.NodeDefinition
|
||||
function ImmersiveWorkStation:new(name, def, nodeDef)
|
||||
local handler = CraftSystem:getImmersiveCraftHandler(def.craftType)
|
||||
|
||||
---@type ImmersiveWorkStation
|
||||
local instance = getInstance(self, {})
|
||||
instance.name = name
|
||||
instance.craftType = def.craftType
|
||||
instance.handler = handler
|
||||
instance.tab = def.tab
|
||||
|
||||
if nodeDef.callbacks == nil then
|
||||
---@type Node.Callbacks
|
||||
nodeDef.callbacks = {}
|
||||
end
|
||||
local settings = nodeDef.settings
|
||||
local callbacks = nodeDef.callbacks
|
||||
|
||||
-- Callback when the work station block is installed in the world
|
||||
-- Ensures initialization of necessary parameters
|
||||
callbacks.on_construct = function(pos)
|
||||
instance:init(pos)
|
||||
end
|
||||
|
||||
-- Callback for interaction with a work station (start of crafting)
|
||||
callbacks.on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
|
||||
instance:showForm(pos, clicker)
|
||||
end
|
||||
|
||||
callbacks.on_punch = function(pos, node, puncher, pointed_thing)
|
||||
instance:abortCraft(pos)
|
||||
end
|
||||
|
||||
callbacks.on_dig = function(pos, node, digger)
|
||||
---@type ImmersiveWorkStation.MetaData
|
||||
local meta = core.get_meta(pos)
|
||||
|
||||
local craftName = meta:get_string('craft_name')
|
||||
if craftName == '' then
|
||||
return core.node_dig(pos, node, digger)
|
||||
else
|
||||
return false
|
||||
end
|
||||
end
|
||||
|
||||
-- Registering a node for Luanti.
|
||||
ImmersiveWorkStationNode:new(nodeDef)
|
||||
|
||||
return instance
|
||||
end
|
||||
|
||||
function ImmersiveWorkStation:showForm(pos, player)
|
||||
local playerName = player:get_player_name()
|
||||
---@type ImmersiveWorkStation.MetaData
|
||||
local meta = core.get_meta(pos)
|
||||
|
||||
local craftName = meta:get_string('craft_name')
|
||||
if craftName ~= '' then
|
||||
core.chat_send_player(playerName, 'The workbench is occupied by another craft.')
|
||||
return
|
||||
end
|
||||
|
||||
PlayerInventoryUI:addActiveNodeForm(pos, playerName)
|
||||
PlayerInventoryUI:setContex(playerName, 'left_tab_name', 'node_tab')
|
||||
PlayerInventoryUI:setContex(playerName, 'node_tab_pos', pos)
|
||||
PlayerInventoryUI:setContex(playerName, 'node_tab', self.tab)
|
||||
|
||||
PlayerInventoryUI:showForm(playerName)
|
||||
end
|
||||
|
||||
---@param pos MapVector
|
||||
function ImmersiveWorkStation:init(pos)
|
||||
---@type ImmersiveWorkStation.MetaData
|
||||
local meta = core.get_meta(pos)
|
||||
end
|
||||
|
||||
---@param pos MapVector
|
||||
function ImmersiveWorkStation:abortCraft(pos)
|
||||
---@type ImmersiveWorkStation.MetaData
|
||||
local meta = core.get_meta(pos)
|
||||
|
||||
local craftName = meta:get_string('craft_name')
|
||||
if craftName == '' then
|
||||
return
|
||||
end
|
||||
|
||||
local craft = self.handler:getCraftByName(craftName)
|
||||
craft:abortCraft(pos)
|
||||
end
|
||||
|
||||
-- --- DEBUG ---
|
||||
|
||||
local handler = CraftSystem:getImmersiveCraftHandler('workbench')
|
||||
|
||||
local require = Mod.getInfo('smc__ui__player_inventory').require
|
||||
local baseGetCraftTab = require('PlayerInventoryUI.baseGetCraftTab')
|
||||
|
||||
---@param self PlayerInventoryUI
|
||||
---@param playerName string
|
||||
---@param tabType PlayerInventoryUI.TabType
|
||||
---@return Formspec
|
||||
local function tab(self, playerName, tabType)
|
||||
return baseGetCraftTab(self, playerName, tabType, 'node_tab', handler)
|
||||
end
|
||||
|
||||
ImmersiveWorkStation:new('test_station', {
|
||||
craftType = 'workbench',
|
||||
tab = tab,
|
||||
},
|
||||
{
|
||||
settings = {
|
||||
name = 'test_station',
|
||||
tiles = {'test_station.png'}
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
handler:registerCraft('bricks', {
|
||||
output = 'rocks:sylite_bricks',
|
||||
recipe = {'rocks:sylite'},
|
||||
startStageName = 'tapping',
|
||||
group = 'test',
|
||||
stages = {
|
||||
---@type CraftSystem.ImmersiveCraftStage.TappingStageDef
|
||||
{
|
||||
name = 'tapping',
|
||||
targetItem = 'rocks:sylite',
|
||||
type = 'tapping',
|
||||
clicksNeed = 3,
|
||||
nextStage = 'tapping_2',
|
||||
},
|
||||
---@type CraftSystem.ImmersiveCraftStage.TappingStageDef
|
||||
{
|
||||
name = 'tapping_2',
|
||||
targetItem = 'rocks:sylite_block',
|
||||
type = 'tapping',
|
||||
clicksNeed = 5,
|
||||
nextStage = 'tapping_3',
|
||||
},
|
||||
---@type CraftSystem.ImmersiveCraftStage.TappingStageDef
|
||||
{
|
||||
name = 'tapping_3',
|
||||
targetItem = 'rocks:sylite_bricks',
|
||||
type = 'tapping',
|
||||
clicksNeed = 1,
|
||||
}
|
||||
},
|
||||
})
|
||||
|
||||
handler:registerCraft('block', {
|
||||
output = 'rocks:sylite_block',
|
||||
recipe = {'rocks:sylite'},
|
||||
startStageName = 'tapping',
|
||||
group = 'test',
|
||||
stages = {
|
||||
---@type CraftSystem.ImmersiveCraftStage.TappingStageDef
|
||||
{
|
||||
name = 'tapping',
|
||||
targetItem = 'rocks:sylite',
|
||||
type = 'tapping',
|
||||
clicksNeed = 5,
|
||||
}
|
||||
},
|
||||
})
|
||||
|
||||
handler:registerCraft('marentine_planks', {
|
||||
output = 'wood:marentine_planks',
|
||||
recipe = {'rocks:sylite'},
|
||||
startStageName = 'tapping',
|
||||
group = 'test',
|
||||
stages = {
|
||||
---@type CraftSystem.ImmersiveCraftStage.TappingStageDef
|
||||
{
|
||||
name = 'tapping',
|
||||
targetItem = 'wood:marentine_log',
|
||||
type = 'tapping',
|
||||
clicksNeed = 5,
|
||||
}
|
||||
},
|
||||
})
|
||||
--]]
|
||||
return ImmersiveWorkStation
|
||||
@@ -1,9 +0,0 @@
|
||||
---@alias ImmersiveWorkStation.MetaData.StringKey 'player_name'|'craft_name'|'stage_name'|'stage_data'
|
||||
---@alias ImmersiveWorkStation.MetaData.FloatKey 'craft_amount'
|
||||
|
||||
---**Only for EmmyLua.**
|
||||
---@class ImmersiveWorkStation.MetaData : NodeMetaRef
|
||||
---@field get_string fun(self, key:ImmersiveWorkStation.MetaData.StringKey):string
|
||||
---@field set_string fun(self, key:ImmersiveWorkStation.MetaData.StringKey, value:string)
|
||||
---@field get_float fun(self, key:ImmersiveWorkStation.MetaData.FloatKey):number
|
||||
---@field set_float fun(self, key:ImmersiveWorkStation.MetaData.FloatKey, value:number)
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 1.2 KiB |
@@ -1,4 +1,4 @@
|
||||
local modInfo = Mod.getInfo('smc__core__item')
|
||||
local require = modInfo.require
|
||||
|
||||
return require('Item')
|
||||
return require('Item')
|
||||
@@ -1,9 +0,0 @@
|
||||
# textdomain: item
|
||||
|
||||
Rarity=Редкость
|
||||
common=простой
|
||||
uncommon=необычный
|
||||
distinguished=выдающийся
|
||||
eminent=исключительный
|
||||
prime=Превосходный
|
||||
unique=Уникальный
|
||||
@@ -1,104 +1,51 @@
|
||||
local tableCopy, tableMerge, colorize = table.copy, table.merge, core.colorize
|
||||
local getInstance = Class.getInstance
|
||||
|
||||
local ItemFactory = Smc.requireItemFactory()
|
||||
local modInfo = Mod.getInfo('smc__core__item')
|
||||
local require = modInfo.require
|
||||
|
||||
---Colors the title according to the rarity of the item.
|
||||
---
|
||||
---Note: that if `true`, the `_title_color` will be ignored.
|
||||
local TITLE_RARITY_COLOR = true
|
||||
local ItemFactory = Mod.getInfo('smc__core__item_factory').require('ItemFactory')
|
||||
|
||||
---Shows rarity on a separate line.
|
||||
local SHOW_RARITY = false
|
||||
|
||||
---Determines whether common rarity will be shown in item descriptions or not.
|
||||
local SHOW_COMMON_RARITY = true
|
||||
|
||||
---Colors corresponding to the rarity color in the item description.
|
||||
---@type table<Item.Rarity, ColorString>
|
||||
local RARITY_COLORS = {
|
||||
['common'] = '#C0C0C0',
|
||||
['uncommon'] = '#7cd2e2',
|
||||
['distinguished'] = '#7ce2da',
|
||||
['eminent'] = '#44d1a9',
|
||||
['prime'] = '#9CF0B1',
|
||||
['unique'] = '#f4c95a'
|
||||
}
|
||||
|
||||
---Whether to show the numeric index in the rarity description.
|
||||
local SHOW_RARITY_INDEX = true
|
||||
|
||||
---@type table<Item.Rarity, integer>
|
||||
local RARITY_INDEX = {
|
||||
['common'] = 1,
|
||||
['uncommon'] = 2,
|
||||
['distinguished'] = 3,
|
||||
['eminent'] = 4,
|
||||
['prime'] = 5,
|
||||
['unique'] = 0
|
||||
}
|
||||
|
||||
---@class Item : Class
|
||||
---@field itemDef Item.ItemDefinition
|
||||
---@field luantiDef ItemDefinition
|
||||
---@field getType fun():string
|
||||
---@field defaultDef Item.ItemDefinition
|
||||
local Item = Class:extend({
|
||||
---@class Item
|
||||
---@field itemDef Item.ItemDefinition
|
||||
---@field luantiDef table
|
||||
---@field getVisual fun(): string
|
||||
---@field defaultDef Item.ItemDefinition
|
||||
local Item = {
|
||||
defaultDef = {
|
||||
settings = {
|
||||
name = '',
|
||||
_title = '',
|
||||
_description = '',
|
||||
_title_color = '#FFFFFF',
|
||||
_description_color = '#838383',
|
||||
_rarity = 'common',
|
||||
_add_mod_name = true,
|
||||
stack_max = 128,
|
||||
name = '',
|
||||
title = '',
|
||||
description = '',
|
||||
titleColor = '#FFFFFF',
|
||||
descriptionColor = '#C0C0C0',
|
||||
addModName = true,
|
||||
},
|
||||
callbacks = {}
|
||||
}
|
||||
})
|
||||
|
||||
---Adds an item's rarity tag to the description.
|
||||
---@param rarity Item.Rarity
|
||||
---@param desc string
|
||||
---@return string
|
||||
local function addRarityToDesc(rarity, desc)
|
||||
if not SHOW_RARITY then
|
||||
return desc
|
||||
end
|
||||
|
||||
if not SHOW_COMMON_RARITY and rarity == 'common' then
|
||||
return desc
|
||||
end
|
||||
|
||||
local S = core.get_translator('item')
|
||||
local color = RARITY_COLORS[rarity]
|
||||
|
||||
local rarityString = S('Rarity')..': '..S(rarity)
|
||||
|
||||
if SHOW_RARITY_INDEX then
|
||||
rarityString = rarityString..' ['..RARITY_INDEX[rarity]..']'
|
||||
end
|
||||
|
||||
return desc..'\n'..colorize(color, rarityString)
|
||||
end
|
||||
}
|
||||
|
||||
---The alias `table.merge` for EmmyLua
|
||||
---@type fun(...):(NodeDefinition|ItemDefinition)
|
||||
local defMerge = function(...)
|
||||
return tableMerge(...)
|
||||
return table.merge(...)
|
||||
end
|
||||
|
||||
---@param itemDef Item.ItemDefinition
|
||||
---@return NodeDefinition|ItemDefinition
|
||||
---@param itemDef Item.ItemDefinition
|
||||
---@return NodeDefinition|ItemDefinition
|
||||
local function itemDefToLuantiDef(itemDef)
|
||||
local modName = Mod.getInfo().shortName
|
||||
local S = core.get_translator(modName)
|
||||
|
||||
itemDef = table.copy(itemDef)
|
||||
local s = itemDef.settings
|
||||
local c = itemDef.callbacks
|
||||
|
||||
local title, description = s._title, s._description
|
||||
if s.addModName then
|
||||
s.name = modName .. ':' .. s.name
|
||||
end
|
||||
|
||||
local title = s.title
|
||||
local description = s.description
|
||||
|
||||
if title == nil or title == '' then
|
||||
title = string.match(s.name, '%S:(%S+)')..'-title'
|
||||
@@ -108,105 +55,74 @@ local function itemDefToLuantiDef(itemDef)
|
||||
description = string.match(s.name, '%S:(%S+)')..'-desc'
|
||||
end
|
||||
|
||||
assert(s._rarity ~= nil, 'The rarity of an item cannot be empty.')
|
||||
|
||||
if s._title_color ~= nil and s._description_color ~= nil then
|
||||
if TITLE_RARITY_COLOR then
|
||||
title = colorize(RARITY_COLORS[s._rarity], S(title))
|
||||
else
|
||||
title = colorize(s._title_color, S(title))
|
||||
end
|
||||
description = colorize(s._description_color, S(description))
|
||||
if s.titleColor ~= nil and s.descriptionColor ~= nil then
|
||||
description = core.colorize(s.titleColor ,S(title))..'\n'..
|
||||
core.colorize(s.descriptionColor, S(description))
|
||||
else
|
||||
error('Item description color parameters cannot be empty.')
|
||||
end
|
||||
|
||||
local luantiDescription = addRarityToDesc(s._rarity, title..'\n '..description)
|
||||
s.title, s.description = nil, description
|
||||
|
||||
s._title = title
|
||||
s._description = description
|
||||
s.description = luantiDescription..core.get_background_escape_sequence('#110F13')
|
||||
|
||||
local luantiDef = defMerge(s, c, true)
|
||||
local luantiDef = defMerge(s, c)
|
||||
|
||||
return luantiDef
|
||||
end
|
||||
|
||||
---@param luantiDef NodeDefinition
|
||||
local function registerNode(luantiDef)
|
||||
local name = luantiDef.name
|
||||
luantiDef.name = nil
|
||||
|
||||
---@param luantiDef NodeDefinition|ItemDefinition
|
||||
local function register3dItem(luantiDef)
|
||||
local ld = luantiDef
|
||||
local name = ld.name
|
||||
ld.name = nil
|
||||
core.register_node(':'..name, luantiDef)
|
||||
end
|
||||
|
||||
---@param luantiDef ItemDefinition
|
||||
local function registerCraftitem(luantiDef)
|
||||
local name = luantiDef.name
|
||||
luantiDef.name = nil
|
||||
|
||||
local function registerFlatItem(luantiDef)
|
||||
local ld = luantiDef
|
||||
local name = ld.name
|
||||
ld.name = nil
|
||||
core.register_craftitem(':'..name, luantiDef)
|
||||
end
|
||||
|
||||
---@param luantiDef ItemDefinition
|
||||
local function registerTool(luantiDef)
|
||||
local name = luantiDef.name
|
||||
luantiDef.name = nil
|
||||
|
||||
core.register_tool(':'..name, luantiDef)
|
||||
---The alias `table.merge` for EmmyLua
|
||||
---@type fun(...):(Item.ItemDefinition)
|
||||
local defMerge = function(...)
|
||||
return table.merge(...)
|
||||
end
|
||||
|
||||
---@param itemDef Item.ItemDefinition|Node.NodeDefinition
|
||||
---@return Item
|
||||
---@param itemDef Item.ItemDefinition|Node.NodeDefinition
|
||||
---@return Item
|
||||
function Item:new(itemDef)
|
||||
assert(itemDef.settings.description == nil,
|
||||
'The item description was specified using `description`, not `_description`. '..
|
||||
'Please note that the `description` field should not be used when registering an item. '..
|
||||
'Use `_title` and `_description` instead.')
|
||||
|
||||
itemDef = tableCopy(itemDef)
|
||||
|
||||
-- Adding default parameterss
|
||||
---@type Item.ItemDefinition
|
||||
itemDef = tableMerge(itemDef, self.defaultDef, true)
|
||||
local s = itemDef.settings
|
||||
|
||||
local shortModName = Mod.getInfo().shortName
|
||||
|
||||
if s._add_mod_name then
|
||||
s.name = shortModName .. ':' .. s.name
|
||||
end
|
||||
---Adding default parameters
|
||||
itemDef = defMerge(itemDef, self.defaultDef, true)
|
||||
|
||||
---@type Item
|
||||
local instance = self:getInstance({})
|
||||
local instance = getInstance(self, {})
|
||||
|
||||
local luantiDef = itemDefToLuantiDef(itemDef)
|
||||
local type = itemDef.settings._type
|
||||
local visual = itemDef.settings.visual
|
||||
|
||||
if type == nil then
|
||||
type = 'craftitem'
|
||||
if visual == nil then
|
||||
visual = 'item_2d'
|
||||
end
|
||||
|
||||
itemDef.settings._type = nil
|
||||
itemDef.settings.visual = nil
|
||||
|
||||
if type == 'node' then
|
||||
registerNode(luantiDef)
|
||||
elseif type == 'craftitem' then
|
||||
registerCraftitem(luantiDef)
|
||||
elseif type == 'tool' then
|
||||
registerTool(luantiDef)
|
||||
if visual == 'item_3d' then
|
||||
register3dItem(luantiDef)
|
||||
else
|
||||
error(('Unknown item type: `%s`.'):format(type))
|
||||
visual = 'item_2d'
|
||||
registerFlatItem(luantiDef)
|
||||
end
|
||||
|
||||
function instance:getType()
|
||||
return type
|
||||
function instance:getVisual()
|
||||
return visual
|
||||
end
|
||||
|
||||
instance.itemDef = itemDef
|
||||
instance.luantiDef = luantiDef
|
||||
|
||||
Smc.addRegisteredItem(shortModName, instance)
|
||||
return instance
|
||||
end
|
||||
|
||||
@@ -216,10 +132,8 @@ end
|
||||
---@param defaultDef Item.ItemDefinition
|
||||
---@return Item
|
||||
function Item:getExtended(defaultDef)
|
||||
defaultDef = tableMerge(defaultDef, self.defaultDef, true)
|
||||
|
||||
---@type Item
|
||||
local ChildClass = self:extend({
|
||||
local ChildClass = Class.extend(self, {
|
||||
defaultDef = defaultDef,
|
||||
})
|
||||
|
||||
@@ -232,8 +146,6 @@ end
|
||||
function Item:getFactory(defaultDef)
|
||||
if defaultDef == nil then
|
||||
defaultDef = self.defaultDef
|
||||
else
|
||||
defaultDef = tableMerge(self.defaultDef, defaultDef, true)
|
||||
end
|
||||
|
||||
---@type ItemFactory
|
||||
|
||||
@@ -64,4 +64,4 @@ Callbacks.on_use = nil
|
||||
---@type fun(itemstack:ItemStack, user:Player|ObjectRef|nil, node, digparams)?
|
||||
Callbacks.after_use = nil
|
||||
|
||||
return Callbacks
|
||||
return Callbacks
|
||||
@@ -1,8 +0,0 @@
|
||||
---Rarity of items:
|
||||
--- * `common`
|
||||
--- * `uncommon`
|
||||
--- * `distinguished`
|
||||
--- * `eminent`
|
||||
--- * `prime`
|
||||
--- * `unique`
|
||||
---@alias Item.Rarity 'common'|'uncommon'|'distinguished'|'eminent'|'prime'|'unique'
|
||||
@@ -5,40 +5,38 @@ local Settings = {}
|
||||
---@type string
|
||||
Settings.name = ''
|
||||
|
||||
---@type string?
|
||||
Settings.description = nil
|
||||
|
||||
---Whether to add the mod name to the settings.name. Default: `true`
|
||||
---@type boolean?
|
||||
Settings._add_mod_name = nil
|
||||
Settings.addModName = nil
|
||||
|
||||
---Item description. 1st line of item description.
|
||||
---@type string?
|
||||
Settings._title = nil
|
||||
Settings.title = nil
|
||||
|
||||
---Item description. The rest of item description.
|
||||
---@type string?
|
||||
Settings._description = nil
|
||||
Settings.description = nil
|
||||
|
||||
---Item title color in description.
|
||||
---
|
||||
---Default: `#FFFFFF`
|
||||
---@type ColorString?
|
||||
Settings._title_color = nil
|
||||
Settings.titleColor = nil
|
||||
|
||||
---Item description color in description.
|
||||
---
|
||||
---Default: `#C0C0C0`
|
||||
---@type ColorString?
|
||||
Settings._description_color = nil
|
||||
Settings.descriptionColor = nil
|
||||
|
||||
---@alias Item.Visual
|
||||
---'item_2d'|
|
||||
---'item_3d'
|
||||
|
||||
---Visual node type.
|
||||
---@type Item.Type?
|
||||
Settings._type = nil
|
||||
---@type Item.Visual?
|
||||
Settings.visual = nil
|
||||
|
||||
---Formal (lore) rarity of an item. Default `common`.
|
||||
---@type Item.Rarity?
|
||||
Settings._rarity = nil
|
||||
|
||||
|
||||
---Table of groups-characteristics of Item.
|
||||
@@ -48,27 +46,6 @@ Settings._rarity = nil
|
||||
---@type table<string,number>?
|
||||
Settings.groups = nil
|
||||
|
||||
---The number of inventory slots that can be stored in an ItemStack.
|
||||
---@type integer?
|
||||
Settings._itemstack_inventory_size = nil
|
||||
|
||||
---The name of the texture that will be displayed as the background
|
||||
---for the item when it is equipped on the player as a bag.
|
||||
---@type string?
|
||||
Settings._itemstack_inventory_background = nil
|
||||
|
||||
---Defines a list of group names that items
|
||||
---with which can be placed in an item's inventory.
|
||||
---
|
||||
---If it is `nil`, then any items will be allowed except those disallowed in `_itemstack_inventory_disallowed_groups`.
|
||||
---@type string[]?
|
||||
Settings._itemstack_inventory_allowed_groups = nil
|
||||
|
||||
---Defines a list of group names that items
|
||||
---with which cannot be placed in an item's inventory.
|
||||
---@type string[]?
|
||||
Settings._itemstack_inventory_disallowed_groups = nil
|
||||
|
||||
|
||||
|
||||
---Texture shown in the inventory GUI.
|
||||
@@ -206,4 +183,4 @@ Settings.touch_interaction = nil
|
||||
Settings.sound = nil
|
||||
|
||||
|
||||
return Settings
|
||||
return Settings
|
||||
@@ -1 +0,0 @@
|
||||
---@alias Item.Type 'craftitem'|'node'|'tool'
|
||||
File diff suppressed because it is too large
Load Diff
@@ -18,10 +18,9 @@ local getInstance = Class.getInstance
|
||||
---@field generateTurf generateFunc
|
||||
---@field generateSoil generateFunc
|
||||
---@field generateBottom generateFunc
|
||||
---@field postProcessing fun(self, mapGenerator:MapGen, factors:MapGen.factors, data:number[], data2:number[], index:number, x:number, y:number, z:number, nodeType:MapGen.nodeType, area:VoxelArea)?
|
||||
local Biome = {}
|
||||
|
||||
---@alias generateFunc fun(self, mapGenerator:MapGen, factors:MapGen.factors, data:number[], data2:number[], index:number, x:number, y:number, z:number)
|
||||
---@alias generateFunc fun(self, mapGenerator:MapGen, data:number[], index:number, x:number, y:number, z:number)
|
||||
|
||||
---Definition table for the `MapGen.Biome`.
|
||||
---
|
||||
@@ -40,98 +39,84 @@ local Biome = {}
|
||||
---@field generateTurf generateFunc?
|
||||
---@field generateSoil generateFunc?
|
||||
---@field generateBottom generateFunc?
|
||||
---@field postProcessing fun(self, mapGenerator:MapGen, factors:MapGen.factors, data:number[], data2:number[], index:number, x:number, y:number, z:number, nodeType:MapGen.nodeType, area:VoxelArea)?
|
||||
|
||||
|
||||
-- Default generate functions
|
||||
|
||||
---@param self MapGen.Biome
|
||||
---@param mapGenerator MapGen
|
||||
---@param factors MapGen.factors
|
||||
---@param data number[]
|
||||
---@param data2 number[]
|
||||
---@param index number
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param z number
|
||||
local defaultGenerateAir = function(self, mapGenerator, factors, data, data2, index, x, y, z)
|
||||
local defaultGenerateAir = function(self, mapGenerator, data, index, x, y, z)
|
||||
data[index] = mapGenerator.nodeIDs.air
|
||||
end
|
||||
|
||||
---@param self MapGen.Biome
|
||||
---@param mapGenerator MapGen
|
||||
---@param factors MapGen.factors
|
||||
---@param data number[]
|
||||
---@param data2 number[]
|
||||
---@param index number
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param z number
|
||||
local defaultGenerateCavernAir = function(self, mapGenerator, factors, data, data2, index, x, y, z)
|
||||
self:generateAir(mapGenerator, factors, data, data2, index, x, y, z)
|
||||
local defaultGenerateCavernAir = function(self, mapGenerator, data, index, x, y, z)
|
||||
self:generateAir(mapGenerator, data, index, x, y, z)
|
||||
end
|
||||
|
||||
---@param self MapGen.Biome
|
||||
---@param mapGenerator MapGen
|
||||
---@param factors MapGen.factors
|
||||
---@param data number[]
|
||||
---@param data2 number[]
|
||||
---@param index number
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param z number
|
||||
local defaultGenerateWater = function(self, mapGenerator, factors, data, data2, index, x, y, z)
|
||||
local defaultGenerateWater = function(self, mapGenerator, data, index, x, y, z)
|
||||
data[index] = mapGenerator.nodeIDs.water
|
||||
end
|
||||
|
||||
---@param self MapGen.Biome
|
||||
---@param mapGenerator MapGen
|
||||
---@param factors MapGen.factors
|
||||
---@param data number[]
|
||||
---@param data2 number[]
|
||||
---@param index number
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param z number
|
||||
local defaultGenerateRock = function(self, mapGenerator, factors, data, data2, index, x, y, z)
|
||||
local defaultGenerateRock = function(self, mapGenerator, data, index, x, y, z)
|
||||
data[index] = self.groundNodesIDs.rock
|
||||
end
|
||||
|
||||
---@param self MapGen.Biome
|
||||
---@param mapGenerator MapGen
|
||||
---@param factors MapGen.factors
|
||||
---@param data number[]
|
||||
---@param data2 number[]
|
||||
---@param index number
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param z number
|
||||
local defaultGenerateTurf = function(self, mapGenerator, factors, data, data2, index, x, y, z)
|
||||
local defaultGenerateTurf = function(self, mapGenerator, data, index, x, y, z)
|
||||
data[index] = self.groundNodesIDs.turf
|
||||
end
|
||||
|
||||
---@param self MapGen.Biome
|
||||
---@param mapGenerator MapGen
|
||||
---@param factors MapGen.factors
|
||||
---@param data number[]
|
||||
---@param data2 number[]
|
||||
---@param index number
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param z number
|
||||
local defaultGenerateSoil = function(self, mapGenerator, factors, data, data2, index, x, y, z)
|
||||
local defaultGenerateSoil = function(self, mapGenerator,data, index, x, y, z)
|
||||
data[index] = self.groundNodesIDs.soil
|
||||
end
|
||||
|
||||
---@param self MapGen.Biome
|
||||
---@param mapGenerator MapGen
|
||||
---@param factors MapGen.factors
|
||||
---@param data number[]
|
||||
---@param data2 number[]
|
||||
---@param index number
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param z number
|
||||
local defaultGenerateBottom = function(self, mapGenerator, factors, data, data2, index, x, y, z)
|
||||
local defaultGenerateBottom = function(self, mapGenerator, data, index, x, y, z)
|
||||
data[index] = self.groundNodesIDs.bottom
|
||||
end
|
||||
|
||||
@@ -182,23 +167,23 @@ function Biome:new(name, def)
|
||||
end
|
||||
|
||||
---@type MapGen.Biome
|
||||
local instance = getInstance(self, {})
|
||||
instance.name = name
|
||||
instance.tempPoint = def.tempPoint
|
||||
instance.humidityPoint = def.humidityPoint
|
||||
instance.minY = def.minY
|
||||
instance.maxY = def.maxY
|
||||
instance.groundNodes = def.groundNodes
|
||||
instance.groundNodesIDs = groundNodesIDs
|
||||
instance.soilHeight = def.soilHeight
|
||||
instance.generateAir = def.generateAir
|
||||
instance.generateCavernAir = def.generateCavernAir
|
||||
instance.generateWater = def.generateWater
|
||||
instance.generateRock = def.generateRock
|
||||
instance.generateSoil = def.generateSoil
|
||||
instance.generateTurf = def.generateTurf
|
||||
instance.generateBottom = def.generateBottom
|
||||
instance.postProcessing = def.postProcessing
|
||||
local instance = getInstance(self, {
|
||||
name = name,
|
||||
tempPoint = def.tempPoint,
|
||||
humidityPoint = def.humidityPoint,
|
||||
minY = def.minY,
|
||||
maxY = def.maxY,
|
||||
groundNodes = def.groundNodes,
|
||||
groundNodesIDs = groundNodesIDs,
|
||||
soilHeight = def.soilHeight,
|
||||
generateAir = def.generateAir,
|
||||
generateCavernAir = def.generateCavernAir,
|
||||
generateWater = def.generateWater,
|
||||
generateRock = def.generateRock,
|
||||
generateSoil = def.generateSoil,
|
||||
generateTurf = def.generateTurf,
|
||||
generateBottom = def.generateBottom,
|
||||
})
|
||||
|
||||
return instance
|
||||
end
|
||||
|
||||
@@ -1,13 +1,5 @@
|
||||
local getInstance = Class.getInstance
|
||||
|
||||
local modInfo = Mod.getInfo('smc__core__map_gen')
|
||||
local require = modInfo.require
|
||||
|
||||
---@type MapGen.Peak
|
||||
local Peak = require('MapGen.Peak')
|
||||
---@type MapGen.Triangle
|
||||
local Triangle = require('MapGen.Triangle')
|
||||
|
||||
---@class MapGen.Layer
|
||||
---@field name string
|
||||
---@field minY integer
|
||||
@@ -19,10 +11,9 @@ local Triangle = require('MapGen.Triangle')
|
||||
---@field waterLevel integer
|
||||
---@field calcTemp fun(self:MapGen.Layer, value:number, height:number):number
|
||||
---@field calcHumidity fun(self:MapGen.Layer, value:number, height:number):number
|
||||
---@field peaksList MapGen.Peak[]
|
||||
---@field peaksByPos table<string, MapGen.Peak>
|
||||
---@field noisesByColor table<MapGen.Layer.Category, table<ColorString, ValueNoise>>
|
||||
---@field noisesParamsByColor table<MapGen.Layer.Category, table<ColorString, NoiseParams>>
|
||||
---@field peaksList {['landscape']:MapGen.Peak[],['temp']:MapGen.Peak[],['humidity']:MapGen.Peak[]}
|
||||
---@field noisesByColor {['landscape']:table<ColorString, ValueNoise>,['temp']:table<ColorString, ValueNoise>,['humidity']:table<ColorString, ValueNoise>}
|
||||
---@field noisesParamsByColor {['landscape']:table<ColorString, NoiseParams>,['temp']:table<ColorString, NoiseParams>,['humidity']:table<ColorString, NoiseParams>}
|
||||
---@field biomesByName table<string, MapGen.Biome>
|
||||
---@field biomesList MapGen.Biome[]
|
||||
---@field biomesDiagram table
|
||||
@@ -31,10 +22,14 @@ local Triangle = require('MapGen.Triangle')
|
||||
---@field cavernsByName table<string, MapGen.Cavern>
|
||||
---@field cavernsList MapGen.Cavern[]
|
||||
---@field regionsByName table<string, MapGen.Region>
|
||||
---@field trianglesList MapGen.Triangle[]
|
||||
---@field trianglesList {['landscape']:MapGen.Triangle[],['temp']:MapGen.Triangle[],['humidity']:MapGen.Triangle[]}
|
||||
---@field tetrahedronsList MapGen.Tetrahedron[] **Not supported**
|
||||
local Layer = {
|
||||
peaksList = {},
|
||||
peaksByPos = {},
|
||||
peaksList = {
|
||||
landscape = {},
|
||||
temp = {},
|
||||
humidity = {},
|
||||
},
|
||||
noisesByColor = {
|
||||
landscape = {},
|
||||
temp = {},
|
||||
@@ -51,7 +46,11 @@ local Layer = {
|
||||
cavernsByName = {},
|
||||
cavernsList = {},
|
||||
regionsByName = {},
|
||||
trianglesList = {},
|
||||
trianglesList = {
|
||||
landscape = {},
|
||||
temp = {},
|
||||
humidity = {},
|
||||
},
|
||||
tetrahedronsList = {},
|
||||
}
|
||||
|
||||
@@ -59,23 +58,17 @@ local Layer = {
|
||||
---
|
||||
---**Only for EmmyLua.**
|
||||
---@class MapGen.LayerDef
|
||||
---@field minY integer
|
||||
---@field maxY integer
|
||||
---@field minTemp integer
|
||||
---@field maxTemp integer
|
||||
---@field minHumidity integer
|
||||
---@field maxHumidity integer
|
||||
---@field waterLevel? integer
|
||||
---@field minY number
|
||||
---@field maxY number
|
||||
---@field minTemp number
|
||||
---@field maxTemp number
|
||||
---@field minHumidity number
|
||||
---@field maxHumidity number
|
||||
---@field waterLevel? number
|
||||
---@field calcTemp (fun(self:MapGen.Layer, value:number, height:number):number)?
|
||||
---@field calcHumidity (fun(self:MapGen.Layer, value:number, height:number):number)?
|
||||
---@field biomesGorizontalScattering integer?
|
||||
---@field biomesVerticalScattering integer?
|
||||
---@field triangulationLandscapeFile string
|
||||
---@field triangulationTempFile string
|
||||
---@field triangulationHumidityFile string
|
||||
---@field landscapeMapScale integer
|
||||
---@field tempMapScale integer
|
||||
---@field humidityMapScale integer
|
||||
---@field biomesGorizontalScattering number?
|
||||
---@field biomesVerticalScattering number?
|
||||
|
||||
---@param self MapGen.Layer
|
||||
---@param value number
|
||||
@@ -85,73 +78,6 @@ local function defaultCalcFunc(self, value, height)
|
||||
return value
|
||||
end
|
||||
|
||||
---Checks `def` for compliance with `MapGen.PeakDef` and creates a new peak
|
||||
---if a peak with such coordinates has not yet been registered or returns an existing one.
|
||||
---
|
||||
---**Note:** If the colors of the new peak and the existing one at the same coordinates
|
||||
---are different, an error will be called.
|
||||
---@param def MapGen.PeakDef
|
||||
---@param scale integer
|
||||
---@return MapGen.Peak
|
||||
function Layer:registerPeak(def, scale)
|
||||
assert(def.pos ~= nil)
|
||||
assert(def.pos.x ~= nil)
|
||||
assert(def.pos.z ~= nil)
|
||||
assert(def.color ~= nil)
|
||||
assert(type(def.color) == 'string')
|
||||
|
||||
def.pos.x = def.pos.x * scale
|
||||
def.pos.z = def.pos.z * scale
|
||||
def.pos.y = 0
|
||||
|
||||
local positionStr = core.pos_to_string(def.pos)
|
||||
|
||||
local peak = self.peaksByPos[positionStr]
|
||||
|
||||
if peak == nil then
|
||||
peak = Peak:new(def)
|
||||
self.peaksByPos[positionStr] = peak
|
||||
elseif peak.color ~= def.color then
|
||||
error('There cannot be two peaks with the same coordinates but different colors.')
|
||||
end
|
||||
|
||||
return peak
|
||||
end
|
||||
|
||||
function Layer:initTrianglesNeighbours()
|
||||
local triangles = self.trianglesList
|
||||
|
||||
for _, triangle in pairs(triangles) do
|
||||
for _, id in ipairs(triangle.neighboursIDs) do
|
||||
table.insert(triangle.neighbours, triangles[id])
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
---@param fileName string
|
||||
---@param category MapGen.Layer.Category
|
||||
---@param scale integer
|
||||
function Layer:getTriaglesFromFile(fileName, category, scale)
|
||||
local file = io.open(core.get_modpath(core.get_current_modname())..'/maps/'..fileName, 'r')
|
||||
assert(file ~= nil)
|
||||
|
||||
local json = core.parse_json(file:read('*a')) or {}
|
||||
file:close()
|
||||
|
||||
local triangles = json.triangles
|
||||
assert(triangles ~= nil)
|
||||
|
||||
for _, tr in ipairs(triangles) do
|
||||
local p1 = self:registerPeak( tr.vertices[1], scale)
|
||||
local p2 = self:registerPeak( tr.vertices[2], scale)
|
||||
local p3 = self:registerPeak( tr.vertices[3], scale)
|
||||
|
||||
local triangle = Triangle:new(tr.id,p1, p2, p3, tr.adjacent_triangle_ids)
|
||||
|
||||
self:addTriangle(category, triangle)
|
||||
end
|
||||
end
|
||||
|
||||
---@param name string
|
||||
---@param def MapGen.LayerDef
|
||||
---@return MapGen.Layer
|
||||
@@ -167,34 +93,20 @@ function Layer:new(name, def)
|
||||
end
|
||||
|
||||
---@type MapGen.Layer
|
||||
local instance = getInstance(self, {})
|
||||
instance.name = name
|
||||
instance.minY = def.minY
|
||||
instance.maxY = def.maxY
|
||||
instance.minTemp = def.minTemp
|
||||
instance.maxTemp = def.maxTemp
|
||||
instance.minHumidity = def.minHumidity
|
||||
instance.maxHumidity = def.maxHumidity
|
||||
instance.waterLevel = def.waterLevel or 0
|
||||
instance.calcTemp = def.calcTemp
|
||||
instance.calcHumidity = def.calcHumidity
|
||||
instance.biomesGorizontalScattering = def.biomesGorizontalScattering or 0
|
||||
instance.biomesVerticalScattering = def.biomesVerticalScattering or 0
|
||||
|
||||
instance:getTriaglesFromFile(
|
||||
def.triangulationLandscapeFile,
|
||||
'landscape',
|
||||
def.landscapeMapScale)
|
||||
instance:getTriaglesFromFile(
|
||||
def.triangulationTempFile,
|
||||
'temp',
|
||||
def.tempMapScale)
|
||||
instance:getTriaglesFromFile(
|
||||
def.triangulationHumidityFile,
|
||||
'humidity',
|
||||
def.humidityMapScale)
|
||||
|
||||
instance:initTrianglesNeighbours()
|
||||
local instance = getInstance(self, {
|
||||
name = name,
|
||||
minY = def.minY,
|
||||
maxY = def.maxY,
|
||||
minTemp = def.minTemp,
|
||||
maxTemp = def.maxTemp,
|
||||
minHumidity = def.minHumidity,
|
||||
maxHumidity = def.maxHumidity,
|
||||
waterLevel = def.waterLevel or 0,
|
||||
calcTemp = def.calcTemp,
|
||||
calcHumidity = def.calcHumidity,
|
||||
biomesGorizontalScattering = def.biomesGorizontalScattering or 0,
|
||||
biomesVerticalScattering = def.biomesVerticalScattering or 0,
|
||||
})
|
||||
|
||||
return instance
|
||||
end
|
||||
@@ -202,34 +114,34 @@ end
|
||||
---A category of noise that affects specific map generation objects.
|
||||
---@alias MapGen.Layer.Category 'landscape'|'temp'|'humidity'
|
||||
|
||||
---Adds a triangle to the `Layer.trianglesList`
|
||||
---Adds a peak to the `Layer.peaksList`
|
||||
---@param category MapGen.Layer.Category
|
||||
---@param triangle MapGen.Triangle
|
||||
function Layer:addTriangle(category, triangle)
|
||||
local triangles = self.trianglesList
|
||||
if triangles ~= nil then
|
||||
triangles[triangle.id] = triangle
|
||||
---@param peak MapGen.Peak
|
||||
function Layer:addPeak(category, peak)
|
||||
if category == 'landscape' then
|
||||
table.insert(self.peaksList.landscape, peak)
|
||||
elseif category == 'temp' then
|
||||
table.insert(self.peaksList.temp, peak)
|
||||
elseif category == 'humidity' then
|
||||
table.insert(self.peaksList.humidity, peak)
|
||||
else
|
||||
error(('There is no peak category named %s.'):format(category))
|
||||
end
|
||||
end
|
||||
|
||||
---Adds a peak to the `Layer.peaksList`
|
||||
---@param category MapGen.Layer.Category
|
||||
---@param peak MapGen.Peak
|
||||
function Layer:addPeak(category, peak)
|
||||
table.insert(self.peaksList, peak)
|
||||
end
|
||||
|
||||
---Returns the `MapGen.Peak` at the coordinates. If there is no peak at these coordinates, it returns `nil`.
|
||||
---@param category MapGen.Layer.Category The category in which the peak is located.
|
||||
---@param pos Position Coordinate of the desired peak.
|
||||
---@return MapGen.Peak?
|
||||
function Layer:getPeakByPos(pos)
|
||||
local positionStr = core.pos_to_string(pos)
|
||||
function Layer:getPeakByPos(category, pos)
|
||||
pos = vector.new(pos)
|
||||
|
||||
local peak = self.peaksByPos[positionStr]
|
||||
|
||||
return peak
|
||||
---@param peak MapGen.Peak
|
||||
for _, peak in ipairs(self.peaksList[category]) do
|
||||
if peak:getPeakPos() == pos then
|
||||
return peak
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
---Adds a NoiseParams color to the `Layer.noisesParamsByColor`
|
||||
|
||||
@@ -2,8 +2,8 @@ local getInstance = Class.getInstance
|
||||
|
||||
---@class MapGen.Peak
|
||||
---@field id number
|
||||
---@field pos vector
|
||||
---@field color ColorString
|
||||
---@field getPeakPos fun(self):vector
|
||||
---@field getColor fun(self):ColorString
|
||||
---@field getGroups fun(self):table<string, number>
|
||||
---@field addGroups fun(self, groups:table<string, number>)
|
||||
local Peak = {
|
||||
@@ -16,13 +16,14 @@ local Peak = {
|
||||
---
|
||||
---**Only for EmmyLua.**
|
||||
---@class MapGen.PeakDef
|
||||
---@field pos MapVector
|
||||
---@field pos vector
|
||||
---@field color ColorString
|
||||
---@field groups? table<string, number>
|
||||
|
||||
---@param def MapGen.PeakDef
|
||||
---@return MapGen.Peak
|
||||
function Peak:new(def)
|
||||
local _pos = def.pos
|
||||
local _color = def.color
|
||||
local _groups
|
||||
|
||||
@@ -38,8 +39,14 @@ function Peak:new(def)
|
||||
__tostring = self.toString,
|
||||
__eq = self.eq
|
||||
})
|
||||
instance.pos = vector.new(def.pos)
|
||||
instance.color = def.color
|
||||
|
||||
function instance:getPeakPos()
|
||||
return _pos:copy()
|
||||
end
|
||||
|
||||
function instance:getColor()
|
||||
return _color
|
||||
end
|
||||
|
||||
function instance:getGroups()
|
||||
return table.copy_with_metatables(_groups)
|
||||
@@ -59,7 +66,7 @@ end
|
||||
---Returns a string describing the object in a readable form.
|
||||
---@return string
|
||||
function Peak:toString()
|
||||
local pos = self.pos
|
||||
local pos = self:getPeakPos()
|
||||
return ('Peak (%s) x: %.2f y: %.2f z: %.2f'):format( self.id, pos.x, pos.y, pos.z)
|
||||
end
|
||||
|
||||
@@ -67,8 +74,8 @@ end
|
||||
---@param other MapGen.Peak
|
||||
---@return boolean
|
||||
function Peak:eq(other)
|
||||
local pos1 = self.pos
|
||||
local pos2 = other.pos
|
||||
local pos1 = self:getPeakPos()
|
||||
local pos2 = other:getPeakPos()
|
||||
|
||||
return pos1.x == pos2.x and pos1.z == pos2.z
|
||||
end
|
||||
|
||||
@@ -4,11 +4,11 @@ local getInstance = Class.getInstance
|
||||
|
||||
---@class MapGen.Region
|
||||
---@field name string
|
||||
---@field vertices MapVector[]
|
||||
---@field vertices Position[]
|
||||
local Region = {}
|
||||
|
||||
---@class MapGen.RegionDef
|
||||
---@field vertices MapVector[]
|
||||
---@field vertices Position[]
|
||||
|
||||
---@param def MapGen.RegionDef
|
||||
---@return MapGen.Region
|
||||
@@ -50,7 +50,7 @@ local function calcDistanceSq(px, pz, x1, z1, x2, z2)
|
||||
end
|
||||
|
||||
---Checks if a point is inside a `MapGen.Region` (2D check using x and z coordinates).
|
||||
---@param point MapVector
|
||||
---@param point Position
|
||||
---@return boolean, number?
|
||||
function Region:pointInRegion(point)
|
||||
local vertices = self.vertices
|
||||
|
||||
@@ -8,7 +8,7 @@ local getInstance = Class.getInstance
|
||||
---@field maxY number
|
||||
---@field staticNode string
|
||||
---@field staticNodeID number
|
||||
---@field generateStaticNode fun(self, mapGenerator:MapGen, data:number[], data2:number[], index:number, x:number, y:number, z:number)
|
||||
---@field generateStaticNode generateFunc
|
||||
local StaticLayer = {}
|
||||
|
||||
---Definition table for the `MapGen.StaticLayer`.
|
||||
@@ -18,17 +18,16 @@ local StaticLayer = {}
|
||||
---@field minY number
|
||||
---@field maxY number
|
||||
---@field staticNode string
|
||||
---@field generateStaticNode fun(self, mapGenerator:MapGen, data:number[], data2:number[], index:number, x:number, y:number, z:number)
|
||||
---@field generateStaticNode generateFunc
|
||||
|
||||
---@param self MapGen.StaticLayer
|
||||
---@param mapGenerator MapGen
|
||||
---@param data number[]
|
||||
---@param data2 number[]
|
||||
---@param index number
|
||||
---@param x number
|
||||
---@param y number
|
||||
---@param z number
|
||||
local defaultGenerateStaticNode = function(self, mapGenerator, data, data2, index, x, y, z)
|
||||
local defaultGenerateStaticNode = function(self, mapGenerator, data, index, x, y, z)
|
||||
data[index] = self.staticNodeID
|
||||
end
|
||||
|
||||
|
||||
154
mods/CORE/MapGen/src/MapGen/Tetrahedron.lua
Normal file
154
mods/CORE/MapGen/src/MapGen/Tetrahedron.lua
Normal file
@@ -0,0 +1,154 @@
|
||||
local mathAbs = math.abs
|
||||
|
||||
local getInstance = Class.getInstance
|
||||
|
||||
local modInfo = Mod.getInfo('smc__core__map_gen')
|
||||
local require = modInfo.require
|
||||
|
||||
---@type MapGen.Triangle
|
||||
local Triangle = require('MapGen.Triangle')
|
||||
---@type MapGen.Triangulation.Edge
|
||||
local Edge = require('MapGen.Triangulation.Edge')
|
||||
---@type MapGen.Triangulation.FakePeak
|
||||
local FakePeak = require('MapGen.Triangulation.FakePeak')
|
||||
|
||||
---@class MapGen.Tetrahedron
|
||||
---@field p1 MapGen.Peak
|
||||
---@field p2 MapGen.Peak
|
||||
---@field p3 MapGen.Peak
|
||||
---@field p4 MapGen.Peak
|
||||
---@field h1 MapGen.Triangulation.Edge
|
||||
---@field h2 MapGen.Triangulation.Edge
|
||||
---@field h3 MapGen.Triangulation.Edge
|
||||
---@field h4 MapGen.Triangulation.Edge
|
||||
---@field f1 MapGen.Triangle
|
||||
---@field f2 MapGen.Triangle
|
||||
---@field f3 MapGen.Triangle
|
||||
---@field f4 MapGen.Triangle
|
||||
local Tetrahedron = {}
|
||||
|
||||
---@param p1 MapGen.Peak
|
||||
---@param p2 MapGen.Peak
|
||||
---@param p3 MapGen.Peak
|
||||
---@param p4 MapGen.Peak
|
||||
---@return MapGen.Tetrahedron
|
||||
function Tetrahedron:new(p1, p2, p3, p4)
|
||||
local instance = getInstance(self, {
|
||||
p1 = p1,
|
||||
p2 = p2,
|
||||
p3 = p3,
|
||||
p4 = p4,
|
||||
h1 = self:getHeight(p1, p2, p3, p4),
|
||||
h2 = self:getHeight(p2, p3, p4, p1),
|
||||
h3 = self:getHeight(p3, p4, p1, p2),
|
||||
h4 = self:getHeight(p4, p1, p2, p3),
|
||||
f1 = Triangle:new(p1, p2, p3),
|
||||
f2 = Triangle:new(p1, p2, p4),
|
||||
f3 = Triangle:new(p1, p3, p4),
|
||||
f4 = Triangle:new(p2, p3, p4),
|
||||
},
|
||||
{
|
||||
__tostring = self.toString
|
||||
})
|
||||
|
||||
return instance
|
||||
end
|
||||
|
||||
---Returns a string describing the object in a readable form.
|
||||
---@return string
|
||||
function Tetrahedron:toString()
|
||||
return ('Tetrahedron: \n %s\n %s\n %s\n %s'):format(
|
||||
tostring(self.p1.getPeakPos()),
|
||||
tostring(self.p2.getPeakPos()),
|
||||
tostring(self.p3.getPeakPos()),
|
||||
tostring(self.p4.getPeakPos())
|
||||
)
|
||||
end
|
||||
|
||||
---@param p1 MapGen.Peak
|
||||
---@param p2 MapGen.Peak
|
||||
---@param p3 MapGen.Peak
|
||||
---@param p4 MapGen.Peak
|
||||
function Tetrahedron:getHeight(p1, p2, p3, p4)
|
||||
local pos1 = p1:getPeakPos()
|
||||
local pos2 = p2:getPeakPos()
|
||||
local pos3 = p3:getPeakPos()
|
||||
local pos4 = p4:getPeakPos()
|
||||
|
||||
-- Векторы, лежащие в плоскости
|
||||
local AB = pos3 - pos2
|
||||
local AC = pos4 - pos2
|
||||
|
||||
-- Нормаль к плоскости
|
||||
local normal = AB:cross(AC)
|
||||
local normal_length = normal:length()
|
||||
|
||||
-- Если плоскость вырождена (точки на одной прямой)
|
||||
if normal_length < 1e-10 then
|
||||
return nil -- или другая обработка ошибки
|
||||
end
|
||||
|
||||
-- Вектор от точки на плоскости к нашей точке
|
||||
local AP = pos1 - pos2
|
||||
|
||||
-- Расстояние от точки до плоскости
|
||||
local distance = AP:dot(normal) / normal_length
|
||||
|
||||
-- Проекция точки на плоскость (вектор!)
|
||||
local projection = pos1 - (normal * (distance / normal_length))
|
||||
|
||||
return Edge:new(p1, FakePeak:new(projection))
|
||||
end
|
||||
|
||||
---Returns the center of the circumscribed sphere.
|
||||
---@return vector
|
||||
function Tetrahedron:getCircumSphereCenter()
|
||||
local pos1 = self.p1.getPeakPos()
|
||||
local pos2 = self.p2.getPeakPos()
|
||||
local pos3 = self.p3.getPeakPos()
|
||||
local pos4 = self.p4.getPeakPos()
|
||||
|
||||
local a = pos2 - pos1
|
||||
local b = pos3 - pos1
|
||||
local c = pos4 - pos1
|
||||
|
||||
local a2 = a:dot(a)
|
||||
local b2 = b:dot(b)
|
||||
local c2 = c:dot(c)
|
||||
|
||||
local cross_bc = b:cross(c)
|
||||
local cross_ca = c:cross(a)
|
||||
local cross_ab = a:cross(b)
|
||||
|
||||
local det = a:dot(b:cross(c)) * 2
|
||||
|
||||
if mathAbs(det) < 0 then
|
||||
return (pos1 + pos2 + pos3 + pos4) / 4
|
||||
end
|
||||
|
||||
local center = pos1 + (cross_bc * a2 + cross_ca * b2 + cross_ab * c2) / det
|
||||
|
||||
return center
|
||||
end
|
||||
|
||||
---Returns the radius of the circumscribed sphere.
|
||||
---@return number
|
||||
function Tetrahedron:getCircumSphereRadius()
|
||||
local center = self:getCircumSphereCenter()
|
||||
local pos1 = self.p1.getPeakPos()
|
||||
return (pos1 - center):length()
|
||||
end
|
||||
|
||||
---Checks whether a given point lies within the circumscribed sphere of a tetrahedron.
|
||||
---@param p MapGen.Peak
|
||||
function Tetrahedron:inCircumSphere(p)
|
||||
local pos = p.getPeakPos()
|
||||
local c = self:getCircumSphereCenter()
|
||||
local r = self:getCircumSphereRadius()
|
||||
|
||||
local distance = (pos - c):length()
|
||||
|
||||
return distance <= r
|
||||
end
|
||||
|
||||
return Tetrahedron
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user