F4SE HTTP

A F4SE plugin to connect to a local http server and exchange strongly typed JSON data with it from Papyrus

Status

• Call http server and receive reply
• Provide a simple strongly typed dictionary
  • string
  • int
  • float
  • bool
  • nested dictionaries
  • arrays
• Serialize and deserialize typed dictionary to and from JSON
• static link all the dependencies so that they don't have to sit in Skyrim's main directory
  • libcurl
  • cpr
  • nlohmann/json
• Make sure this works on
  • Fallout 4
  • Fallout VR

Usage

Create a strongly typed dictionary from Papyrus and send it as json to a local http server.
Papyrus interface strongly influenced by JContainers

function CallHttpServer()
    ;create a new dictionary and get its handle
    int handle = F4SE_HTTP.createDictionary()
    ;use the handle to store the string *"startConversation"* using the key "requestType"
    F4SE_HTTP.setString(handle, "requestType", "startConversation")
    F4SE_HTTP.setString(handle, "npc", "Lydia")
    ;use the handle to store the bool *false* using the key "isInCombatWithPlayer"
    F4SE_HTTP.setBool(handle, "isInCombatWithPlayer", false)
    ;use the handle to store the float *0.123* using the key "testFloat"
    F4SE_HTTP.setFloat(handle, "testFloat", 0.123)

    ;create a second dictionary and get its handle
    int handleForContext = F4SE_HTTP.createDictionary()
    ;use the new handleForContext to store the string *"Dragonsreach"* using the key "location"
    F4SE_HTTP.setString(handleForContext, "location", "Dragonsreach")
    ;use the new handleForContext to store the int *1328* using the key "time"
    F4SE_HTTP.setInt(handleForContext, "time", 1328)
    ;set the new handleForContext as a nested dictionary under the first dictionary using the "context" key
    F4SE_HTTP.setNestedDictionary(handle,"context",handleForContext)

    ;send the dictionary handle to *http://localhost:5000/mantella*
    F4SE_HTTP.sendLocalhostHttpRequest(handle,5000,"mantella")    
endFunction

Receive the reply from the http server

event OnInit()
    ;Register for the event *OnHttpReplyReceived* or/and *OnHttpErrorReceived* using a custom event
    RegisterForExternalEvent("OnHttpReplyReceived","OnHttpReplyReceived")
    RegisterForExternalEvent("OnHttpErrorReceived","OnHttpErrorReceived")
endEvent

;*OnHttpReplyReceived* provides a handle to a dictionary that contains the contents of the reply
function OnHttpReplyReceived(int typedDictionaryHandle)
    ;retrieve string from dictionary using key "replytype". The last parameter is a default that will be used if the value does not exist
    string replyType = F4SE_HTTP.getString(typedDictionaryHandle, "replytype", "Error: No reply type received")
    string npc = F4SE_HTTP.getString(typedDictionaryHandle, "npc", "Error: No npc to say stuff")
    bool npcLikesPlayer = F4SE_HTTP.getBool(typedDictionaryHandle, "npcLikesPlayer", false)
    float testFloat = F4SE_HTTP.getFloat(typedDictionaryHandle, "testFloat", 1)

    int contextHandle = F4SE_HTTP.getNestedDictionary(typedDictionaryHandle, "context", 0)
    string current_location = F4SE_HTTP.getString(contextHandle, "location", "Only the gods know where")
    int time = F4SE_HTTP.getInt(contextHandle, "time", 0)
    DoSomethingWithAllThisStuff()
endFunction

Uses https://github.com/alandtse/CommonLibF4 Many thanks!

Based on https://github.com/SkyrimScripting/SKSE_Templates Many thanks!