Files
simple-makes-complex/docs/docs/modules/MapGen.Peak.md

1.2 KiB

global MapGen.Peak


methods


Peak.getPeakPos


function Peak.getPeakPos(self)-> vector

Peak.getColor


function Peak.getColor(self)-> ColorString

Peak.getGroups


function Peak.getGroups(self)
-> table<string,number>

Peak.new


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


function Peak.toString() ->  string

Returns a string describing the object in a readable form.

Peak.eq


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


Peak.id : number