Komplette Sichtung und Dokumentierung der nicht Lua-Funktionen

» Settlers Map Source Forums » Siedler DEdK Script Forum » Komplette Sichtung und Dokumentierung der nicht Lua-Funktionen

Pages: 1

mcb
#1
16-01-2015 14:09
Posts: 1111

Komplette Sichtung und Dokumentierung der nicht Lua-Funktionen

Hi, ich bin gerade dabei alle nicht Lua-Funktionen (z.B. Logic) zu katalogisieren und dokumentieren. Als Ziel habe ich eine Lua-Bibliothek (mit leeren Funktionen) die die Dokumentation für diese Funktionen für eine Lua-IDE bereitstellt. Sobald ich fertig bin, werden die Files hier verlinkt.
Als Quellen benutze ich das Wiki, Mads Seite, die S5 Demo (von yoq) und die per bba-Tool entpakten BB-Scripte.

Wenn ich mir nicht sicher bin, tauchen in der Dokumentation ? auf.
Warnungen markiere ich mit !.
Die Dokumentationen aus der Demo sind mit !!! democopy markiert.
Ich dokumentiere nicht alle Parameter und Rückgabewerde, sondern nur, wenn es nicht schon aus dem Parameternamen hervorgeht.

Beispiel:

--- !!! democopy
-- Gibt Gebäude zurück, bei denen Spieler, UpgradeCategory und Ort passen.
-- return: id1, id2, ...
function Logic.GetBuildingsByUpgradeCategory(_upCat, _player, _posX, _posY, _range, _amount) end



Funktionslisten:
GDB
Script
Logic
AI
XGUIEng
Framework
Camera
Trigger
Events
Event
Display
GUI
tables (Eine .zip mit den meisten tables mit Konstanten, z.B. Entities, maschinell erstellt)
Input

Falls irgendwer Informationen über bestimmte Funktionen hat, oder mir helfen will, PN an mich oder hier in den Thread. Schon mal Danke im Vorraus.

This posting has been edited by mcb: 14-12-2015 at 19:21.

MadShadow
#2
18-01-2015 13:43
Posts: 338

Stellt "meine" Seite nicht genau so etwas dar?
Was sind die Gründe das nochmal neu aufzusetzen anstatt dort einzutragen?

mcb
#3
18-01-2015 14:00
Posts: 1111

Der Grund ist, dass ich die Lua-Dateien in einer IDE nutzen kann. Damit funktioniert z.B. Autokomplete richtig und ich bekomme einen Tooltip mit der Beschreibung zu jeder Funktion.

MadShadow
#4
19-01-2015 20:17
Posts: 338

Das klingt sehr praktisch. Wenn du möchtest kann ich dir alle XNetwork und XNetworkUbiCom Funktionen erstellen. Schick mir am besten ein Muster von einer Tabelle damit ich sehe wie sie aufgebaut ist.

mcb
#5
19-01-2015 23:53
Posts: 1111

Gerne. Sieh mal in meinem ersten Beitrag, da sind schon 3 tables verlinkt. Eventuell muss ich noch @param und @return Tags einfügen, aber momentan spinnt luadocumentator noch ein wenig und zeigt die nicht an...

mcb
#6
11-02-2015 14:10
Posts: 1111

Update: AI, XGUIEng, Framework, Camera hochgeladen

This posting has been edited by mcb: 13-02-2015 at 12:46.

mcb
#7
27-06-2015 15:46
Posts: 1111

Hab zwar wenig Zeit, aber das Projekt ist noch nicht gestorben
Update: Trigger, Events, Event hochgeladen.

Kantelo
#8
27-06-2015 17:59
Posts: 346

Wobei alles Events ja auch nur für bestimmte Zahlen stehen:

LOGIC_EVENT_DIPLOMACY_CHANGED = 114690
LOGIC_EVENT_TRIBUTE_PAID = 114691
LOGIC_EVENT_RESEARCH_DONE = 114692
LOGIC_EVENT_GOODS_TRADED = 114693
LOGIC_EVENT_WEATHER_STATE_CHANGED = 114694
LOGIC_EVENT_ENTITY_HURT_ENTITY = 114695
LOGIC_EVENT_EVERY_SECOND = 131077
LOGIC_EVENT_EVERY_TURN = 131078
LOGIC_EVENT_ENTITY_CREATED = 131094
LOGIC_EVENT_ENTITY_DESTROYED = 131095
LOGIC_EVENT_PLAYER_DIED = 131096
LOGIC_EVENT_ENTITY_IN_RANGE_OF_ENTITY = 131097

mcb
#9
27-06-2015 19:52
Posts: 1111

Ist mir klar, damit LDT die Variablen aber wiedererkennt (und mir den Kommentar einblendet) reicht auch ein nil. Ich war also nur zu faul, die Zahlen auszulesen

mcb
#10
31-07-2015 13:48
Posts: 1111

Update: Display (ziemlich leer...), GUI und die meisten tables ohne Funktionen (Entities,...).
(Die tables hab ich Maschinell von http://www.dedk.de/wiki/doku.php?id=s5lua_g:zumcopypaste übernommen)

mcb
#11
14-12-2015 19:23
Posts: 1111

Update: Kantelo hat Input erstellt und einige Funktionen in Logic, GUI und Display ergänzt.

totalwarANGEL
#12
15-12-2015 07:21
Posts: 2049

Siedler 6 hat kein LOGIC_EVENT_ENTITY_CREATED.
(kein funktionierendes)

____________________
Liebe ist wie ein Kopfschuss!

Zedeg
#13
15-12-2015 14:52
Posts: 384

Wie könnt ihr dann überhaupt arbeiten?

____________________
Journalisten erkundigen sich bei Wissenschaftlern meist nicht nach Grundlagen, sondern eher nach Ergebnissen und Folgerungen. Das erklärt womöglich auch, warum sich Forschungsberichte in den Medien so häufig als feststehende Erkenntnisse lesen, nicht aber als Ideen, Entdeckungen oder Indizien, um die es sich genau genommen in den meisten Fällen handelt. -Axel Bojowski

yoq
#14
15-12-2015 20:36
Posts: 90

Die Erklärung zu den Mode-Bits ist nicht ganz richtig, es handelt sich dabei um ein Bitfeld. Die Zahlen für die Modes in welchen die Zuweisung gelten soll werden einfach addiert. Beispielsweise gilt 12=4+8 nur für Cutscene und Video.

____________________
S5 & S6: Lua Script Debugger (Thread) | bbaTool
S5: S5Hook (Thread) | S5 GUI Editor | S5 Grafikupgrade + nVidia fix | Win10 Creators Update

totalwarANGEL
#15
17-12-2015 01:19
Posts: 2049

Posted by Zedeg:
Wie könnt ihr dann überhaupt arbeiten?


GameCallback_EntityCreated - schließt aber Spieler 0 aus, was echt hinderlich ist, wenn man was mit den Tieren vor hat.

____________________
Liebe ist wie ein Kopfschuss!

mcb
#16
17-12-2015 13:33
Posts: 1111

Posted by yoq:
Die Erklärung zu den Mode-Bits ist nicht ganz richtig, es handelt sich dabei um ein Bitfeld. Die Zahlen für die Modes in welchen die Zuweisung gelten soll werden einfach addiert. Beispielsweise gilt 12=4+8 nur für Cutscene und Video.



Stimmt, macht so auch mehr Sinn. Habs eben geändert.

Pages: 1

SiteEngine v1.5.0 by nevermind, ©2005-2007
Design by SpiderFive (www.siedler-games.de) - English translation by juja

Impressum