SU Library

Aktuelle Version: 0.3.0

Mit dieser SU Library, die direkt in Settlers United integriert ist, werden fortlaufend neue Lua-Funktionen ( SU Library Functions ) und Lua-Enums ( SU API Enums ) den Mappern zur Verfügung gestellt.

Wünsche und Vorschläge für neue Funktionalitäten können gerne über Discord mitgeteilt werden.

Installation

Keine explizite Installation benötigt, da diese SU Library automatisch mit Settlers United installiert wird!

Version überprüfen

Neue Funktionen werden immer wieder zur SU Library hinzugefügt. Damit ein Skript, das auf Funktionen einer neueren Version basiert, als der Spieler lokal zur Verfügung hat, nicht abstürzt, sollte vorher auf die höchste Version der SU Library geprüft werden, die benötigt wird.

Beispiel: Wird die Funktion SU.Game.AddBeds verwendet, steht oben auf der Seite der Funktion "SU Library: erst ab Version 0.2.0 verfügbar!", d.h. um diese Funktion fehlerfrei verwenden zu können, muss beim Spieler mindestens die Version 0.2.0 vorhanden sein!

Der Einfachheit halber kann auch direkt auf die neueste Version geprüft werden, die zum Zeitpunkt der Erstellung des Skripts vorhanden war, die wird immer auf dieser Seite ganz oben sichtbar sein.

Das folgende Skript kann verwendet werden, um auf die entsprechende benötigte Version zu prüfen. Die Variable requiredVersion muss entsprechend angepasst werden.

WICHTIG: in Lua werden Abfragen ohne rechter Seite auch bei 0 zu "true" evaluiert (z.B. bei "if SU.VersionOK("0.0.0") then [body] end" wird der [body] immer ausgeführt, auch wenn die Funktion 0 zurückgibt! Daher immer "== 0" verwenden!)

function new_game()
  -- don't add anything in this function above these lines
  if SU then
    local requiredVersion = "0.3.0" -- TODO change this to the version your map-script requires
    if SU.VersionOK(requiredVersion) == 0 then
      dbg.stm("SU Library Version requirement not met! The Map-Script needs at least Version "..requiredVersion..", you have Version "..SU.VERSION.."!")
      dbg.stm("Update (and restart The Settlers IV via) Settlers United to get the latest Version installed.")
      return
    end
  else
    dbg.stm("SU Library is missing!")
    dbg.stm("Update (and restart The Settlers IV via) Settlers United to get the latest Version installed.")
    return
  end
  
  -- SU Library loaded and required Version fulfilled
  -- add your normal code here...
end

SU.VERSION - Gibt die aktuelle vollständige Version an (Beispiel: 0.2.1) SU.MAJOR_VERSION - Gibt die aktuelle Hauptversion an (Beispiel: 0) SU.MINOR_VERSION - Gibt die aktuelle Nebenversion an (Beispiel: 2) SU.AUTHOR - Gibt die aktuellen Autoren an