Skip to Content
defold-typescript libraries
megalanthusdefold-gamepush

megalanthus/defold-gamepush/gamepush.core.files

GamePush files: upload, choose, load and fetch player files, with their events.

  • GitHub: megalanthus/defold-gamepush — pinned to v1.4.1
    1. Pick a release from megalanthus/defold-gamepush releases and add its Source code (zip) URL (or a packaged .zip asset, if the library ships one) to game.project under [project] dependencies, then Fetch Libraries in the Defold editor.
    2. Run bunx @defold-typescript/cli resolve to materialize its types.
    3. Import it under a namespace alias of your choice:
      import * as core_files from "gamepush.core.files"

Functions

upload(parameters: Record<string, unknown>, callback?: (result: unknown) => void)

Uploads a file the player chooses. Raises when the table is missing.

Parameters

  • parameters: Record<string, unknown> — The upload options, for example { accept: ".txt, .json" }.
  • callback?: (result: unknown) => void — Receives the result.

upload_url(parameters: Record<string, unknown>, callback?: (result: unknown) => void)

Uploads a file from a URL. Raises when the table is missing.

Parameters

  • parameters: Record<string, unknown> — The upload options, for example { filename: "save.txt", url: "https://...", tags: ["level7"] }.
  • callback?: (result: unknown) => void — Receives the result.

upload_content(parameters: Record<string, unknown>, callback?: (result: unknown) => void)

Uploads content as a file. Raises when the table is missing.

Parameters

  • parameters: Record<string, unknown> — The upload options, for example { filename: "save.txt", content: "Hello world!" }.
  • callback?: (result: unknown) => void — Receives the result.

load_content(uri: string, callback?: (result: unknown) => void)

Loads a file's content.

Parameters

  • uri: string — The file's address.
  • callback?: (result: unknown) => void — Receives the content.

choose_file(accept?: string, callback?: (result: unknown) => void)

Asks the player to choose a file. The binding checks accept but does not pass it on to the SDK.

Parameters

  • accept?: string — The file types to offer, for example ".txt, .json".
  • callback?: (result: unknown) => void — Receives the result.

fetch(parameters?: Record<string, unknown>, callback?: (result: unknown) => void)

Fetches files.

Parameters

  • parameters?: Record<string, unknown> — The fetch options.
  • callback?: (result: unknown) => void — Receives the result.

fetch_more(parameters?: Record<string, unknown>, callback?: (result: unknown) => void)

Fetches more files.

Parameters

  • parameters?: Record<string, unknown> — The fetch options, for example { limit: 2 }.
  • callback?: (result: unknown) => void — Receives the result.

can_upload(): boolean

Whether the player can upload files.

Returns

  • boolean

Variables

callbacks: FilesCallbacks

The event handlers.

Types

FilesCallbacks

FilesCallbacks.upload?: (result: unknown) => void

A file was uploaded.

FilesCallbacks.error_upload?: (error: unknown) => void

Uploading a file failed.

FilesCallbacks.load_content?: (result: unknown) => void

A file's content was loaded.

FilesCallbacks.error_load_content?: (error: unknown) => void

Loading a file's content failed.

FilesCallbacks.choose?: (result: unknown) => void

The player chose a file.

FilesCallbacks.error_choose?: (error: unknown) => void

Choosing a file failed.

FilesCallbacks.fetch?: (result: unknown) => void

The files were fetched.

FilesCallbacks.error_fetch?: (error: unknown) => void

Fetching the files failed.

FilesCallbacks.fetch_more?: (result: unknown) => void

More files were fetched.

FilesCallbacks.error_fetch_more?: (error: unknown) => void

Fetching more files failed.

On this page