rettungssimulator/resi-community

Repository mit Wiki zu APIs und Sockets, zum Melden von technischen Fehlern und anfragen von neuen technischen Features auf https://rettungssimulator.online

ReSi-Community

Bugs & Wiki comming soon

Wiki

Fehler melden

resi-community's Issues

Socket: newChatMessage

Socket Request

Endpunkt Name
newChatMessage

Funktionsbeschreibung
Wird ausgelöst, wenn es eine neue Chatnachricht gibt.

• Rückgabe von Daten
• Ändern von Spieldaten

Nutzen des Endpunkts
Ich würde gerne in der Codebase einen kleinen Alarm einbauen

kein Code, da Socket

API: /buildings

API Request

Endpunkt Name
/api/buildings

Funktionsbeschreibung
Rückgabe von Informationsdaten von Gebäuden

• Rückgabe von Daten

Nutzen des Endpunkts
Nutzung der Daten in meinem Script zum Gebäude zählen. Würde mir das manuelle ergänzen von Gebäuden nach Update sparen. Generell auch mit den Informationen in anderen Scripten nutzbar.

Anfrage Parameter

Antwort Daten

1 -> buildingType des Gebäudes
departmentName -> Name der im Shop angezeigt wird
organizationName -> Name der Organisation der der Wache angehört
organizationID -> Id der Organisation der die Wache angehört
maxLevel -> Maximale Ausbaustufe
defaultPersonal -> Standardmäßige Anzahl an Personal auf der Wache
defaultMuenzen -> Standardkosten (Münzen)
defaultMarken -> Standardkosten (Marken)
description -> Beschreibung die im Shop angezeigt wird
markerName -> Name des Markers der auf der Karte verwendet wird
buildingCategory -> Kategorie des Gebäudes (school/department/controlCenter)
generates -> Lässt das Gebäude Einsätze generieren?

Welche Daten erhälst du als Antwort?

• JSON

{
  1: {
    "departmentName": "Feuerwache",
    "organizationName": "Feuerwehr",
    "organizationID": 1,
    "maxLevel": 10,
    "defaultPersonal": 12,
    "defaultMuenzen": 75000,
    "defaultMarken": 50,
    "description": "Stellplatz für Feuerwehrfahrzeuge",
    "markerName": "fireDepartment",
    "buildingCategory": "department",
    "generates": true
  }
}

/api/association/ Erweiterung

Funktionsbeschreibung
Zusätzliche Rückgabe von:

• Aktuelle Anzahl Verbandsmitglieder

Nutzen des Endpunkts
Monatliche Statistik des Verbandes durch Bot im Discord posten

Antwort Daten
siehe unten, API Text erweitert

• Einzelner Wert, numerisch

[
    {
    associationID : 14,
    associationName : "Verbands Name",
    associationMember : <number>
    associationMuenzenTotal : 29852010,
    associationMuenzenBank : null
    }
]

Grüße
QuCla

API: /organizations

API Request

Endpunkt Name
ˋ/api/organizationsˋ

Funktionsbeschreibung

• Rückgabe von Daten

Nutzen des Endpunkts
Für detailliertere Infos bei Skripten

Anfrage Parameter
id: optionaler URL Parameter der die ID angibt für eine bestimmte Organisation

Antwort Daten
Welche Daten erhälst du als Antwort?

• JSON

{
  id: "Organisations id (als int)",
  shortName: "Kurzer Name (z.B. FW)",
  name: "Langer Name (z.B. Feuerwehr)",
  buildings: "Gebäude ids der Organisation (als int array)"
}

Verbesserung couseSocket

API Request

Ich würde mir im updateCouse-Socket zusätzlich ein Feld courseName und courseType wünschen, wo Name und ID des Lehrgangs mit angegeben werden.
Grüßle

ControlCenter.missions ergänzen

Die Einsätze im ControlCenter.missions sollten jeweils auch die entsprechende missionid enthalten. Bei Rückfragen gerne über Discord melden.

Fehler/ Änderungswunsch socket-Event "missionStatus"

Der Parameter patientCount ändert sich nicht wenn Patienten abtransportiert werden.
Falls dies kein Fehler ist, wäre das ein Änderungsvorschlag für das socket-Event.
Der patientCount sollte immer den aktuellen Patienten des Einsatzes anzeigen.

Bei Rückfragen gern hier oder per Discord Kontakt aufnehmen.
Gruß
Traxx

api/userBuildings Erweiterung

Erweiterung API

api/userBuildings

Erweiterung des Endpoints um die Punkte "personalCount" und evtl. "maxNeededPersonalCount".
Letzteres wäre die Anzahl an Personen die man benötigt um alle Fahrzeuge vollzubesetzen.

Beispiel Rückgabe:

[ 
    {
        "userBuildingID" : 43,
        "buildingType": 1,
        "userBuildingName" : "Name",
        "level" : 3,
        "isHiring" : false,
        "location" : 
        {
            "lat" : 51.42069,
            "lng" : 9.42069
        },
        "address" : "Auf der Straße 3, 42069 Stadt",
        "personalCount": 13,
        "maxNeededPersonalCount": 15
    },
    {
        "userBuildingID" : 44,
        "buildingType": 2,
        "userBuildingName" : "Name",
        "level" : 1,
        "isHiring" : true,
        "location" : 
        {
            "lat" : 52.53251,
            "lng" : 6.4251
        },
        "address" : "Auf dem Weg 52, 95241 Ort",
        "personalCount": 10,
        "maxNeededPersonalCount": 9
    }
]

/api/association/ Erweiterung um Bettenbelegung

Funktionsbeschreibung
Zusätzliche Rückgabe von:

Belegung der Verbandsgebäude
Nutzen des Endpunkts

Verwendung in Skript zur Ausgabe weiterer Verbandsinfos
Antwort siehe unten, API Text erweitert

Zwei Werte, numerisch
[
{
Erweiterung der einzelnen Array Datenpunkte "associationSharedBuildings[x]" um Gesamtanzahl der Betten und Anzahl belegter Betten
}
]

Danke und Gruß
QuCla

/api/association/ Erweiterung

Funktionsbeschreibung
Zusätzliche Rückgabe von:

• Aktuelle Verbandsposition in der Topliste

Nutzen des Endpunkts

• Verwendung in Skript zur Ausgabe der Verbandsposition sowie weiterer Verbandsinfos

Antwort Daten
siehe unten, API Text erweitert

• Einzelner Wert, numerisch

[
{
associationID : 14,
associationName : "Verbands Name",
associationRank :
associationMuenzenTotal : 29852010,
associationMuenzenBank : null
}
]

Grüße
QuCla

muenzenUpdate socket ergänzen und verbessern

Der Münzen socket sollte neben dem neuen Wert auch den alten Münzen Wert und ggf. die Differenz enthalten. Des weiteren sollten die Daten als Zahl und nicht schon formatiert übermittelt werden, damit sie universell einfacher einzusetzen sind.

rettungssimulator.online/script/* von 404-Seite ausnehmen

Würde es deutlich leichter machen, eigene Frames zu erstellen bzw. man könnte halt das Script dann speziell auf diesen Include auslegen, wie z.B. /scripts/nizi112/notes. Erstmal wäre das ganze dann von den Includes immer aktuell wenn ihr euren Head da einbindet, und dann funktioniert auch so nen Kram wie z.B. Frame neu laden oder so. Danke 😊

Erweiterung der API userBuildings um die ID der Leitstelle

API Request

Endpunkt Name
/api/userBuildings

Funktionsbeschreibung
Übergabe der zugeordneten Leitstelle in der userBuildings-API

• Rückgabe von Daten
• Ändern von Spieldaten

Nutzen des Endpunkts
Die Sortierung und Gruppierung von Gebäuden des Spielers wird so immens vereinfacht

Anfrage Parameter
Dies soll eine Erweiterung einer bestehenden API sein

Antwort Daten
dispatchBuildingID: Number

nur Daten der Erweiterung:

[
    {
      "dispatchBuildingID": "Number"
    }
]

API: /vehicles

API Request

Endpunkt Name
ˋ/api/vehiclesˋ

Funktionsbeschreibung

• Rückgabe von Daten

Nutzen des Endpunkts
Für detailliertere Infos bei Skripten

Anfrage Parameter

id: optionaler URL Parameter der die ID angibt für ein bestimmtes Fahrzeug

Antwort Daten

• JSON

{
  id: "Fahrzeug id (als int)",
  shortName: "Kurzer Name (z.B. HLF 20)",
  name: "Langer Name (z.B. Hilfeleistungslöschgruppenfahrzeug 20 )",
  defaultCrewMin: "Minimale Standard Besatzung (als int)",
  defaultCrewMax: "Maximale Standard Besatzung (als int)",
  priceMuenzen: "Münzenpreis (als int)",
  priceMarken: "Markenpreis (als int)",
  markerPath: "Pfad zur Fahrzeuggrafik auf der Karte (ohne ani)",
  availableOnBuildings: "Auf welchen Gebäuden ist das Fahrzeug verfügbar, am besten die Gebäude ids ggf. als array für später (als int)",
  shopCategory: "In welcher Kategorie wird das Fahrzeug im shop angezeigt",
  vehicleCategory: "Zu welcher Kategorie gehört das Fahrzeug (LF, HLF, SW)"
}

API für alle im Spiel vorhandenen Fahrzeugtypen

API Request

Endpunkt Name
Der Name des neuen Endpunktes

Funktionsbeschreibung
Beschreibung der erwarteten Funktionalität des Endpunktes

• Rückgabe von Daten
• Ändern von Spieldaten

Nutzen des Endpunkts
Wofür benötigst du die Daten? Wozu werden diese weiter verarbeitet?

Anfrage Parameter
Welche Parameter sollen erwartet werden?
[METHODE] parameterName=['values'] - (Optional J/N)

Antwort Daten
Welche Daten erhälst du als Antwort?
Ein Array of Objects mit den im Spiel vorhandenen Fahrzeugen .

• Einzelner Wert
• JSON
• JSON Array
• Fehler/Bestätigungs Meldung

[
    {
      id: "integer",
      class: ["string"],
      class_alias: ["string"],
      cost: "integer",
      personal: { min: "integer", max: "integer" },
      qualification: [
            { name: "string", needed: "integer" }
      ]
    }
]

/api/association/ Ergänzung

Funktionsbeschreibung
Zusätzliche Rückgabe von:

Anzahl Mitglieder Online
Nutzen des Endpunkts

Verwendung in Skript zur Ausgabe weiterer Verbandsinfos
Antwort siehe unten, API Text erweitert

Einzelner Wert, numerisch
[
{
associationID : 14,
associationName : "Verbands Name",
associationMemberOnline : 'number'
associationMuenzenTotal : 29852010,
associationMuenzenBank : null
}
]

Grüße
QuCla

Veränderung PatientStatus Socket

Hey ho,
wäre es evnt. möglich, beim PatientStatus 2 die userMissionID mit zu übergeben und nicht nur bei neuen Patienten? Ansonsten muss man sich das aus mehreren zusammenbasteln und das ist nicht so cool, weil immer Daten verloren gehen können, wenn der Spieler z.B. offline ist und der Socket deswegen garnicht auslöst.
Grüße

/api/user Erweiterung

API Erweiterung: /api/user - Rückgabe von weiteren Daten

Funktionsbeschreibung
Zusätzliche Rückgabe von:

• gesamt abgeschlossene Einsätze
• heute abgeschlossene Einsätze
• gesamt unterstütze Einsätze
• heute unterstützte Einsätze

Nutzen des Endpunkts
den Einsatzzähler fehlerfrei zu gestalten und auch die Einsätze zu zählen, die mobil oder während der Spieler offline war abgeschlossen wurden

Antwort Daten
siehe unten

[
    {
      finishedMissionsTotal: <number>,
      finishedMissionsToday: <number>,
      supportedMissionsTotal: <number>,
      supportedMissionsToday: <number>,
    }
]

Grüße,
NiZi112