Siedler DEdK Wiki

In diesem Artikel wird beschrieben, wie einem Spieler ein Tribut zur Verfügung gestellt werden kann, den er im F3-Menü unter einem einstellbaren Ressourceneinsatz bezahlen kann. Oft werden Ressourcen direkt eingetauscht, Truppen gekauft, Diplomatie verändert oder Tore geöffnet, sobald ein Tribut bezahlt wurde.

Damit die im Folgenden beschriebenen Codebeispiele funktionieren, muss sich folgende Komfortfunktion ebenfalls in deinem Skript befinden:

-- Komfortfunktion für das Bereitstellen von Tributen
function AddTribute(_tribute)
    assert(type(_tribute) == "table", "Tribut muß ein Table sein");
    assert(type(_tribute.text) == "string", "Tribut.text muß ein String sein");
    assert(type(_tribute.cost) == "table", "Tribut.cost muß ein Table sein");
    assert(type(_tribute.playerId) == "number", "Tribut.playerId muß eine Nummer sein");
    assert(not _tribute.Tribute, "Tribut.Tribute darf nicht vorbelegt sein");
 
    -- Hier wird eine globale Variable gesetzt, die außerhalb dieser Funktion nicht manipuliert werden sollte
    uniqueTributeCounter = uniqueTributeCounter or 1;
    _tribute.Tribute = uniqueTributeCounter;
    uniqueTributeCounter = uniqueTributeCounter + 1;
 
    local tResCost = {};
    for k, v in pairs(_tribute.cost) do
        assert(ResourceType[k]);
        assert(type(v) == "number");
        table.insert(tResCost, ResourceType[k]);
        table.insert(tResCost, v);
    end
 
    Logic.AddTribute(_tribute.playerId, _tribute.Tribute, 0, 0, _tribute.text, unpack(tResCost));
    SetupTributePaid(_tribute);
 
    return _tribute.Tribute;
end

Die Tribut-Handhabung wird dadurch deutlich erleichtert.

Die oben gezeigte Funktion AddTribute(_tribute) hat nur einen Parameter _tribute. _tribute muss ein Table sein, das den zu erstellenden Tribut beschreibt. Ein Standard-Tribut hat nur wenige notwendige Parameter:

Wichtig: Beachte bei den Keys des _tribute-Tables sowie des cost-Tables darin auf die korrekte Groß- und Kleinschreibung! Die ist leider nicht über alle Parameter hinweg konsistent.

In einem einfachen Tribut-Beispiel soll Spieler 1 die Eisengrube eines Verbündeten für 500 Gold und 300 Holz erstehen können. Die Eisengrube existiert auf der Karte und hat den Skriptnamen „IronMine“.

function CreateTributeBuyIronMine()
    local Tribute = {
        playerId = 1,
        text = "Für 500 Taler und 300 Holz erhaltet Ihr die Eisenmine Eures Verbündeten",
        cost = {
            -- Die Namen der Ressourcen werden groß geschrieben
            Gold = 500,
            Wood = 300
        },
        Callback = CallbackTributeBuyIronMine
    }
 
    AddTribute(Tribute)
end
 
function CallbackTributeBuyIronMine()
    -- ChangePlayer ändert den Spieler, dem diese Entity gehört
    -- Mehr dazu findest du in der Comfort-Referenz oder im Artikel zu "Belohnungen" auf Ebene 2
    ChangePlayer("IronMine", 1)
end

Wichtig: Es können maximal 6 Tribute gleichzeitig im F3-Menü angezeigt werden! Wenn du weitere Tribute hinzufügst, hat der Spieler keinen Zugriff mehr darauf.

Die Verwendung einer Callback-Funktion erlaubt es dir, maximal flexibel auf die Entrichtung eines Tributs zu reagieren. Für einige Standardfälle gibt es allerdings vorgefertigte, optionale Parameter, die ein Standard-Callback automatisch generieren und ausführen.

Achtung: Diese optionalen Parameter sollten nur im Singleplayer benutzt werden!

Hinweis: Für die Spawn-Option müssen pro Trupp alle Parameter angegeben werden, wobei die Ralleypoint und AttackRalleypoint-Optionen sich gegenseitig ausschließen.

Für jeden dieser optionalen Parameter wollen wir ein kleines Beispiel und dessen Voraussetzungen geben.

Ein Händler bietet einen Tribut zum Tausch einer Ressource gegen eine andere an:

function CreateTributeBuyIron()
    local Tribute = {
        playerId = 1,
        text = "Für 500 Holz erhaltet Ihr 300 Eisen",
        cost = {
            Wood = 500
        },
        Resources = {
            -- Achtung! Die Keys der erhaltenen Ressourcen werden klein geschrieben!
            iron = 300
        }
    }
 
    AddTribute(Tribute)
end

Ein Dieb bietet an, die Technologie „Sabotieren“ zu verkaufen:

function CreateTributeBuySabotage()
    local Tribute = {
        playerId = 1,
        text = "Für 700 Taler und 400 Schwefel erhaltet Ihr die Technologie 'Sabotage'",
        cost = {
            Gold = 700,
            Sulfur = 400
        },
        Technologies = { Technologies.T_ThiefSabotage }
    }
 
    AddTribute(Tribute)
end

Wie das Beispiel von ganz oben: Der Spieler kann eine Eisengrube erstehen. Sie hat den Skriptnamen „IronMine“ auf der Karte:

function CreateTributeBuyIronMine()
    local Tribute = {
        playerId = 1,
        text = "Für 500 Taler und 300 Holz erhaltet Ihr die Eisenmine Eures Verbündeten",
        cost = {
            Gold = 500,
            Wood = 300
        },
        Entity = "IronMine"
    }
 
    AddTribute(Tribute)
end

Dario kauft sich zu Beginn einer Partie einige Leibeigene. Für das folgende Beispiel müssen auf der Karte eine Entity mit dem Skriptnamen „Dario“ existieren, sowie einige Leibeigene, die nach dem Schema „Serf1“, „Serf2“, usw. benannt sind.

function CreateTributeBuySerfs()
    local Tribute = {
        playerId = 1,
        text = "Für 200 Taler erhaltet Ihr einige Leibeigene",
        cost = {
            Gold = 200,
        },
        -- Alle Entities mit dem Namen "Serf"..i werden dem Spieler übergeben...
        Entities = "Serf",
        -- ...und laufen nach dem Kauf zu Dario
        Ralleypoint = "Dario"
    }
 
    AddTribute(Tribute)
end

Dario holt sich bei einem befreundeten Dorf Verstärkung. Damit die Truppen eine Position zum Spawnen haben, sollte eine ScriptEntity angelegt werden, die wir hier „TroopSpawn“ nennen. Auch muss wieder ein „Dario“ auf der Karte sein, zu dem die Truppen laufen können.

function CreateTributeBuyTroops()
    local Tribute = {
        playerId = 1,
        text = "Für 800 Taler, 400 Holz und 200 Eisen erhaltet Ihr vom Nachbardorf einige Truppen zur Unterstützung",
        cost = {
            Gold = 800,
            Wood = 400,
            Iron = 200
        },
        -- Das Table Spawn ist eine Liste, in der die zu spawnenden Truppen nacheinander beschrieben sind
        Spawn = {
            -- Gespawnt werden:
            -- 1 Trupp Kurzschwertkämpfer
            { Pos = "TroopSpawn", LeaderType = Entities.PU_LeaderSword1, Soldiers = 4, Ralleypoint = "Dario" },
            -- 2 Truppen Kurzbogenschützen
            { Pos = "TroopSpawn", LeaderType = Entities.PU_LeaderBow1, Soldiers = 4, Ralleypoint = "Dario" },
            { Pos = "TroopSpawn", LeaderType = Entities.PU_LeaderBow1, Soldiers = 4, Ralleypoint = "Dario" },
            -- und 1 Trupp schwerer Reiter
            { Pos = "TroopSpawn", LeaderType = Entities.PU_LeaderHeavyCavalry1, Soldiers = 3, Ralleypoint = "Dario" }
        }
    }
 
    AddTribute(Tribute)
end

Um Tribute wieder zu entfernen, wird die Funktion Logic.RemoveTribute(_PlayerId, _TributeId) verwendet. Die _TributeId ist dabei der Rückgabewert der Funktion AddTribute. Wenn du beispielsweise so einen Tribut definierst:

function CreateTributeBuyIronMine()
    local Tribute = {
        playerId = 1,
        text = "Für 500 Taler und 300 Holz erhaltet Ihr die Eisenmine Eures Verbündeten",
        cost = {
            -- Die Namen der Ressourcen werden groß geschrieben
            Gold = 500,
            Wood = 300
        },
        Callback = CallbackTributeBuyIronMine
    }
 
    return Tribute.playerId, AddTribute(Tribute)
end

bekommst du die Spieler-Id und die Tribut-Id beim Aufruf zurück:

TributeBuyIronMinePlayerId, TributeBuyIronMineTributeId = CreateTributeBuyIronMine()

Danach kannst du mit diesen beiden Variablen den Tribut wieder entfernen:

Logic.RemoveTribute(TributeBuyIronMinePlayerId, TributeBuyIronMineTributeId)