Manuals
Manuals




This translation is community contributed and may not be up to date. We only maintain the English version of the documentation. Read this manual in English

Yerel kod eklentileri için otomatik tamamlama

Defold düzenleyicisi, tüm Defold API işlevleri için otomatik tamamlama (auto-complete) önerileri sunar ve betiklerinizin gerektirdiği Lua modülleri için öneriler oluşturur. Ancak düzenleyici, yerel kod eklentilerinin (native extension) sunduğu işlevler için kendiliğinden otomatik tamamlama önerileri sunamaz. Bir yerel kod eklentisi, kendi API’si için de otomatik tamamlama önerilerini etkinleştirmek üzere ayrı bir dosyada API tanımı sağlayabilir.

Betik API tanımı oluşturma

Betik API tanım dosyasının uzantısı .script_api şeklindedir. Dosyanın YAML biçiminde olması ve eklenti dosyalarıyla birlikte bulunması gerekir. Betik API tanımı için beklenen biçim şöyledir:

- 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
    ...

Türler, table, string , boolean, number, function türlerinden herhangi biri olabilir. Bir değer birden fazla türde olabiliyorsa [type1, type2, type3] biçiminde yazılır.

Türler şu anda düzenleyicide gösterilmez. Düzenleyici tür bilgilerini göstermeyi desteklediğinde kullanılabilmeleri için bunları yine de belirtmeniz önerilir.

Örnekler

Gerçek kullanım örnekleri için aşağıdaki projelere bakın: