Autouzupełnianie dla rozszerzeń natywnych

Edytor Defold udostępnia podpowiedzi autouzupełniania dla wszystkich funkcji API Defold i generuje sugestie dla modułów Lua wymaganych przez twoje skrypty. Nie potrafi jednak automatycznie oferować podpowiedzi autouzupełniania dla funkcjonalności wystawianej przez rozszerzenia natywne. Rozszerzenie natywne może dostarczyć definicję API w osobnym pliku, aby włączyć podpowiedzi autouzupełniania także dla API rozszerzenia.

Tworzenie definicji API skryptu

Plik definicji API skryptu ma rozszerzenie .script_api. Musi być zapisany w formacie YAML i znajdować się razem z plikami rozszerzenia. Oczekiwany format definicji API skryptu wygląda tak:

- name: The name of the extension
  type: table
  desc: Extension description
  members:
  - name: Name of the first member
    type: Member type
    desc: Member description
    # if member type is "function"
    parameters:
    - name: Name of the first parameter
      type: Parameter type
      desc: Parameter description
    - name: Name of the second parameter
      type: Parameter type
      desc: Parameter description
    # if member type is "function"
    returns:
    - name: Name of first return value
      type: Return value type
      desc: Return value description
    examples:
    - desc: First example of member usage
    - desc: Second example of member usage

  - name: Name of the second member
    ...

Typami mogą być dowolne z table, string , boolean, number, function. Jeśli wartość może mieć wiele typów, zapisuje się ją jako [type1, type2, type3].

Przykłady

Przykłady rzeczywistego użycia znajdziesz w następujących projektach:

• Facebook extension
• WebView extension