Class engine.NameGenerator

Creates a random name generator with a set of rules

Usage:

     The lang_def parameter is a table that must look like this:
     {
       phonemesVocals = "a, e, i, o, u, y",
       phonemesConsonants = "b, c, ch, ck, cz, d, dh, f, g, gh, h, j, k, kh, l, m, n, p, ph, q, r, rh, s, sh, t, th, ts, tz, v, w, x, z, zh",
       syllablesStart = "Aer, Al, Am, An, Ar, Arm, Arth, B, Bal, Bar, Be, Bel, Ber, Bok, Bor, Bran, Breg, Bren, Brod, Cam, Chal, Cham, Ch, Cuth, Dag, Daim, Dair, Del, Dr, Dur, Duv, Ear, Elen, Er, Erel, Erem, Fal, Ful, Gal, G, Get, Gil, Gor, Grin, Gun, H, Hal, Han, Har, Hath, Hett, Hur, Iss, Khel, K, Kor, Lel, Lor, M, Mal, Man, Mard, N, Ol, Radh, Rag, Relg, Rh, Run, Sam, Tarr, T, Tor, Tul, Tur, Ul, Ulf, Unr, Ur, Urth, Yar, Z, Zan, Zer",
       syllablesMiddle = "de, do, dra, du, duna, ga, go, hara, kaltho, la, latha, le, ma, nari, ra, re, rego, ro, rodda, romi, rui, sa, to, ya, zila",
       syllablesEnd = "bar, bers, blek, chak, chik, dan, dar, das, dig, dil, din, dir, dor, dur, fang, fast, gar, gas, gen, gorn, grim, gund, had, hek, hell, hir, hor, kan, kath, khad, kor, lach, lar, ldil, ldir, leg, len, lin, mas, mnir, ndil, ndur, neg, nik, ntir, rab, rach, rain, rak, ran, rand, rath, rek, rig, rim, rin, rion, sin, sta, stir, sus, tar, thad, thel, tir, von, vor, yon, zor",
       rules = "$s$v$35m$10m$e",
     }
    
     The rules field defines how names are generated. Any special character found inside (starting with a $, with an optional number and a character) will be replaced by a random word from one of the lists.<br>
     $P = syllablesPre<br>
     $s = syllablesStart<br>
     $m = syllablesMiddle<br>
     $e = syllablesEnd<br>
     $p = syllablesPost<br>
     $v = phonemesVocals<br>
     $c = phonemesConsonants<br>
     If a number is give it is a percent chance for this part to exist.

Methods



Methods

engine.NameGenerator:generate (rule)
Generates a name

Parameters:

  • rule if not nil this is a generation rule to use instead of a random one
generated by LDoc 1.4.3