UploadDownloadTextFile.json

{
  "author": "",
  "category": "Network",
  "extensionNamespace": "",
  "fullName": "Upload/Download files",
  "gdevelopVersion": ">=5.5.222",
  "helpPath": "https://developer.mozilla.org/en-US/docs/Web/API/File_API/Using_files_from_web_applications",
  "iconUrl": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48IURPQ1RZUEUgc3ZnIFBVQkxJQyAiLS8vVzNDLy9EVEQgU1ZHIDEuMS8vRU4iICJodHRwOi8vd3d3LnczLm9yZy9HcmFwaGljcy9TVkcvMS4xL0RURC9zdmcxMS5kdGQiPjxzdmcgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgdmVyc2lvbj0iMS4xIiBpZD0ibWRpLXVwbG9hZCIgd2lkdGg9IjI0IiBoZWlnaHQ9IjI0IiB2aWV3Qm94PSIwIDAgMjQgMjQiPjxwYXRoIGQ9Ik05LDE2VjEwSDVMMTIsM0wxOSwxMEgxNVYxNkg5TTUsMjBWMThIMTlWMjBINVoiIC8+PC9zdmc+",
  "name": "UploadDownloadTextFile",
  "previewIconUrl": "https://asset-resources.gdevelop.io/public-resources/Icons/16a8e2514d1c9a57f65f506bb7a420bf63e53dc56c58dfceff63178893031c69_upload.svg",
  "shortDescription": "Allows users to upload/download text content to a filename and vice versa. ",
  "version": "2.0.0",
  "description": [
    "Allows users to upload and download text files (JSON or plain text).",
    "",
    "## Usage",
    "",
    "**Download a file:**",
    "```",
    "Download [file type] with filename [name], containing [text content]",
    "```",
    "",
    "**Upload a file:**",
    "```",
    "Upload a [file type] to text input [variable], with ID [unique ID]",
    "```",
    "",
    "Then check if upload finished:",
    "```",
    "Uploading text file with id [unique ID] finished?",
    "```",
    "",
    "## Example",
    "",
    "To save game data, use the download action with your filename and JSON content. To load it back, use the upload action with a unique ID, then wait for the upload finished condition before reading the variable."
  ],
  "origin": {
    "identifier": "UploadDownloadTextFile",
    "name": "gdevelop-extension-store"
  },
  "tags": [
    "download",
    "upload",
    "text",
    "file",
    "browser",
    "dom apis"
  ],
  "authorIds": [
    "rotBq28wITdtfsrE7McHQri4k2w2",
    "D7erWGZ1oEMfqC61eTysriJsrIx2"
  ],
  "dependencies": [],
  "globalVariables": [],
  "sceneVariables": [],
  "eventsFunctions": [
    {
      "description": "Download file with text content.",
      "fullName": "Download file with text content",
      "functionType": "Action",
      "name": "DownloadTextFile",
      "sentence": "Download _PARAM3_ with filename _PARAM1_, containing __PARAM2_",
      "events": [
        {
          "type": "BuiltinCommonInstructions::JsCode",
          "inlineCode": [
            "function DownloadTextContent(filename, mimeType,content) {",
            "    var link = document.createElement('a')",
            "    var blob = new Blob([content], {type: mimeType})",
            "    var url = URL.createObjectURL(blob);",
            "",
            "    link.setAttribute('href', url);",
            "    link.setAttribute('download', filename);",
            "    link.click();",
            "    link.remove();",
            "}",
            "",
            "const FileName = eventsFunctionContext.getArgument(\"FileName\");",
            "const TextContent = eventsFunctionContext.getArgument(\"TextContent\");",
            "",
            "DownloadTextContent(FileName, eventsFunctionContext.getArgument(\"filetype\"), TextContent);"
          ],
          "parameterObjects": "",
          "useStrict": true,
          "eventsSheetExpanded": true
        }
      ],
      "parameters": [
        {
          "description": "FileName",
          "name": "FileName",
          "type": "string"
        },
        {
          "description": "TextContent",
          "name": "TextContent",
          "type": "string"
        },
        {
          "description": "Type",
          "name": "filetype",
          "supplementaryInformation": "[\"application/json\",\"text/plain\"]",
          "type": "stringWithSelector"
        }
      ],
      "objectGroups": []
    },
    {
      "description": "Upload a text file to text input.",
      "fullName": "Upload a text file to text input",
      "functionType": "Action",
      "name": "UploadTextFile",
      "sentence": "Upload a _PARAM2_ to text input _PARAM1_, with the following ID _PARAM3_",
      "events": [
        {
          "type": "BuiltinCommonInstructions::JsCode",
          "inlineCode": [
            "// --- Get Arguments ---",
            "const allowedFileTypes = [eventsFunctionContext.getArgument(\"filetype\")];",
            "const SceneVariable = eventsFunctionContext.getArgument(\"Variable\");",
            "const transactionID = eventsFunctionContext.getArgument(\"ID\");",
            "",
            "// --- Setup Input ---",
            "const InputElement = document.createElement('input');",
            "InputElement.type = \"file\";",
            "InputElement.addEventListener(\"change\", handleFiles, false);",
            "InputElement.click();",
            "",
            "// --- Setup Status Variable ---",
            "const Uploading = runtimeScene.getVariables().get(\"__UploadDownloadTextFile\");",
            "// Reset status and clear old ID",
            "Uploading.fromJSObject({Uploading:false, ID:transactionID}); ",
            "",
            "// --- Handle File ---",
            "async function handleFiles() {",
            "  const files = this.files;",
            "  ",
            "  if (!files.length) {",
            "    SceneVariable.setString(\"No Files Selected!\");",
            "  } else if(!allowedFileTypes.includes(files[0].type)) {",
            "    SceneVariable.setString(\"Please choose text files only.\");",
            "  } else {",
            "    SceneVariable.setString(await files[0].text());",
            "  }",
            "  Uploading.fromJSObject({Uploading:true, ID:transactionID}); ",
            "  InputElement.remove();",
            "}"
          ],
          "parameterObjects": "TextInput",
          "useStrict": true,
          "eventsSheetExpanded": true
        }
      ],
      "parameters": [
        {
          "description": "Variable",
          "name": "Variable",
          "type": "variable"
        },
        {
          "description": "Type",
          "name": "filetype",
          "supplementaryInformation": "[\"application/json\",\"text/plain\"]",
          "type": "stringWithSelector"
        },
        {
          "description": "Upload ID",
          "name": "ID",
          "supplementaryInformation": "sceneID",
          "type": "identifier"
        }
      ],
      "objectGroups": []
    },
    {
      "description": "Uploading text file finished.",
      "fullName": "Uploading text file finished?",
      "functionType": "Condition",
      "name": "UploadFinished",
      "sentence": "Uploading text file with id _PARAM1_ finished?",
      "events": [
        {
          "type": "BuiltinCommonInstructions::JsCode",
          "inlineCode": [
            "const Uploading = runtimeScene.getVariables().get(\"__UploadDownloadTextFile\");",
            "const ID = eventsFunctionContext.getArgument(\"ID\");",
            "const upload = Uploading.toJSObject();",
            "",
            "console.log(upload)",
            "",
            "if (upload.Uploading && upload.ID === ID) { // Use strict equality (===)",
            "    eventsFunctionContext.returnValue = true;",
            "} else {",
            "    eventsFunctionContext.returnValue = false;",
            "}"
          ],
          "parameterObjects": "",
          "useStrict": true,
          "eventsSheetExpanded": false
        }
      ],
      "parameters": [
        {
          "description": "Upload ID",
          "name": "ID",
          "supplementaryInformation": "sceneID",
          "type": "identifier"
        }
      ],
      "objectGroups": []
    }
  ],
  "eventsBasedBehaviors": [],
  "eventsBasedObjects": []
}