الصفحة الرئيسية>المتعلقة بالبرمجة>شفرة المصدر الأخرى
تنزيل

لعبة Jolt API لجودو

لعبة Jolt API لجودو

غلاف لـ Game Jolt API الذي يعمل من خلال طلبات HTTP. فهو يحتوي على جميع نقاط نهاية Game Jolt API ويهدف إلى تبسيط استخدامه حيثما كان ذلك ممكنًا. متوافق مع جودو 4.x. للحصول على إصدار Godot 3.x، راجع هذا الفرع.

للحصول على أمثلة للاستخدام، راجع الوثائق أدناه. يوجد أيضًا مشهد نموذجي في addons/gamejolt/example يحتوي على جميع نقاط النهاية والمعلمات على الواجهة الرسومية.

لعبة Jolt API لجودو

التوثيق

ملاحظة: أي معلمة متبوعة بـ ? هو اختياري. مثال: sessions_ping(status?) -> GameJolt .

فِهرِس

  • إشارات
  • عام
  • المستخدمين
  • الجلسات
  • عشرات
  • الجوائز
  • تخزين البيانات
  • أصدقاء
  • وقت
  • المكالمات الجماعية

الإعداد الأولي

  • قم بتمكين المكون الإضافي في Project Settings > Plugins
  • قم بتعيين معرف اللعبة والمفتاح الخاص لتتمكن من تنفيذ طلبات واجهة برمجة التطبيقات (API) في Project Settings > General > Game Jolt > Config > Global .
  • اختياريًا، يمكنك تعيين اسم مستخدم افتراضي ورمز مميز في Project Settings > General > Game Jolt > Config > Debug .
    • سيتم استخدام هذه الخصائص فقط كإعدادات افتراضية في إصدارات المحرر وتصحيح الأخطاء، مما يسمح بإجراء اختبار ونماذج أولية أسهل.
    • عند إنشاء الإصدار، يجب عليك تعيين اسم المستخدم والرمز المميز يدويًا. انظر الطرق العامة.

بعد هذا الإعداد، يمكنك تنفيذ طلبات واجهة برمجة التطبيقات (API) باستخدام الطرق الموضحة أدناه على GameJolt المفرد الموجود على الكود الخاص بك.

التعامل مع استجابات الطلب

تُصدر كل طريقة من طرق Game Jolt API إشارة بعد اكتمال الطلب، سواء كان ناجحًا أم لا. يمكنك توصيل إشارات محددة لالتقاط الاستجابات عند عمليات رد اتصال الطريقة: 

 func _ready () -> void :
    GameJolt . time_completed . connect ( _on_GameJolt_time_completed )
    GameJolt . time ()


func _on_GameJolt_time_completed ( result : Dictionary ) -> void :
    # Do something with the request result...

أو يمكنك await نتيجة الإشارة في متغير: 

 func _onButtonTime_pressed () -> void :
    GameJolt . time ()
    var result : Dictionary = await GameJolt . time_completed
    # Do something with the request result...

ملحوظة: جميع الإشارات ترجع response: Dictionary .

إشارات

عام

  • user_name_changed
  • user_token_changed
  • game_id_changed
  • private_key_changed

المستخدمين

  • users_fetch_completed(response: Dictionary)
  • users_auth_completed(response: Dictionary)

الجلسات

  • sessions_open_completed(response: Dictionary)
  • sessions_ping_completed(response: Dictionary)
  • sessions_check_completed(response: Dictionary)
  • sessions_close_completed(response: Dictionary)

عشرات

  • scores_fetch_completed(response: Dictionary)
  • scores_tables_completed(response: Dictionary)
  • scores_add_completed(response: Dictionary)
  • scores_get_rank_completed(response: Dictionary)

الجوائز

  • trophies_fetch_completed(response: Dictionary)
  • trophies_add_achieved_completed(response: Dictionary)
  • trophies_remove_achieved_completed(response: Dictionary)

تخزين البيانات

  • data_store_set_completed(response: Dictionary)
  • data_store_update_completed(response: Dictionary)
  • data_store_remove_completed(response: Dictionary)
  • data_store_fetch_completed(response: Dictionary)
  • data_store_get_keys_completed(response: Dictionary)

أصدقاء

  • friends_completed(response: Dictionary)

وقت

  • time_completed(response: Dictionary)

المكالمات الجماعية

  • batch_completed(response: Dictionary)

عام

الطرق العامة لتكوين GameJolt المفرد محليًا.

set_user_name(القيمة)

قم بتعيين اسم المستخدم للمصادقة ومهام نطاق المستخدم الأخرى. يصدر user_name_changed .

  • value: String -> اسم المستخدم.

get_user_name() -> سلسلة

الحصول على اسم المستخدم الحالي.

set_user_token(القيمة)

قم بتعيين رمز المستخدم للمصادقة ومهام نطاق المستخدم الأخرى. يصدر user_token_changed .

  • value: String -> رمز لعبة المستخدم.

get_user_token() -> سلسلة

احصل على رمز لعبة المستخدم الحالي.

set_game_id(القيمة)

قم بتعيين معرف اللعبة المطلوب لجميع المهام. يصدر game_id_changed .

  • value: String -> معرف اللعبة من مشروع Game Jolt الخاص بك.

get_game_id() -> سلسلة

احصل على معرف اللعبة الحالي.

set_private_key(القيمة)

قم بتعيين المفتاح الخاص اللازم لجميع المهام. ينبعث private_key_changed .

  • value: String -> المفتاح الخاص للعبة من مشروع Game Jolt الخاص بك.

get_private_key() -> سلسلة

احصل على المفتاح الخاص للعبة الحالية.

المستخدمين

users_fetch(user_name?, user_ids?) -> GameJolt

إرجاع بيانات المستخدم. يُصدر users_fetch_completed .

  • user_name: String (اختياري) -> اسم المستخدم للمستخدم الذي تريد جلب بياناته.
  • user_ids: Array[String|int] (اختياري) -> معرفات المستخدمين الذين ترغب في جلب بياناتهم.

ملاحظة: المعلمات user_name و user_ids متنافيتان، ويجب عليك استخدام واحد منهما فقط، أو لا شيء. إذا لم يتم توفير أي شيء، فسيتم جلبه من اسم المستخدم الحالي المعين في GameJolt Singleton.

users_auth() -> GameJolt

يصادق على معلومات المستخدم. يجب أن يتم ذلك قبل إجراء أي مكالمات للمستخدم، للتأكد من صحة بيانات اعتماد المستخدم (اسم المستخدم والرمز المميز). يجب تعيين اسم المستخدم والرمز المميز على GameJolt المفرد حتى ينجح. يُصدر users_auth_completed .

الجلسات

session_open() -> GameJolt

يفتح جلسة لعبة لمستخدم معين ويسمح لك بإخبار Game Jolt بأن المستخدم يلعب لعبتك. يجب عليك تنفيذ الأمر ping على الجلسة لإبقائها نشطة ويجب عليك إغلاقها عند الانتهاء منها. يصدر sessions_open_completed .

ملحوظات:

  • يمكنك الحصول على جلسة مفتوحة واحدة فقط للمستخدم في كل مرة. إذا حاولت فتح جلسة جديدة أثناء تشغيل إحدى الجلسات، فسيقوم النظام بإغلاق الجلسة الحالية قبل فتح الجلسة الجديدة.
  • يتطلب تعيين اسم المستخدم والرمز المميز على GameJolt المفرد.

session_ping(الحالة؟) -> GameJolt

يصدر اتصالًا بجلسة مفتوحة لإخبار النظام بأنه لا يزال نشطًا. إذا لم يتم اختبار اتصال الجلسة خلال 120 ثانية، فسيقوم النظام بإغلاق الجلسة وسيتعين عليك فتح جلسة أخرى. يوصى بإجراء اختبار الاتصال كل 30 ثانية تقريبًا لمنع النظام من مسح جلستك. يمكنك أيضًا السماح للنظام بمعرفة ما إذا كان اللاعب في حالة "active" أو "idle" داخل لعبتك. يصدر sessions_ping_completed .

  • status: String (اختياري) -> لتعيين حالة الجلسة إما "active" أو "idle" .

ملاحظة: يتطلب تعيين اسم المستخدم والرمز المميز على GameJolt المفرد.

session_check() -> GameJolt

يتحقق لمعرفة ما إذا كانت هناك جلسة مفتوحة للمستخدم. يمكن استخدامه لمعرفة ما إذا كان حساب مستخدم معين نشطًا في اللعبة. يصدر sessions_check_completed .

ملحوظات:

  • تقوم نقطة النهاية هذه بإرجاع false لحقل "success" في حالة عدم وجود جلسة مفتوحة. يختلف هذا السلوك عن نقاط النهاية الأخرى التي تستخدم هذا الحقل للإشارة إلى حالة الخطأ.
  • يتطلب تعيين اسم المستخدم والرمز المميز على GameJolt المفرد.

session_ Close () -> GameJolt

يغلق الجلسة النشطة. تنبعث sessions_close_completed .

ملاحظة: يتطلب تعيين اسم المستخدم والرمز المميز على GameJolt المفرد.

عشرات

Scores_fetch(limit?, table_id?, Guest?, Better_than?,أسوأ_من?, this_user?) -> GameJolt

إرجاع قائمة بالنتائج إما للمستخدم أو عالميًا للعبة. ينبعث scores_fetch_completed .

  • limit: String|int (اختياري) -> عدد الدرجات التي ترغب في إرجاعها.
  • table_id: String|int (اختياري) -> معرف جدول النتائج.
  • guest: String (اختياري) -> اسم الضيف.
  • better_than: String|int (اختياري) -> جلب النتائج الأفضل من قيمة فرز النتيجة هذه فقط.
  • worse_than: String|int (اختياري) -> جلب الدرجات الأسوأ من قيمة فرز النتيجة هذه فقط.
  • this_user: bool (اختياري) -> إذا كان true ، فاجلب عشرات المستخدمين الحاليين فقط. بخلاف ذلك، قم بإحضار عشرات من كافة المستخدمين.

ملحوظات:

  • يتطلب تعيين اسم المستخدم والرمز المميز على GameJolt المفرد إذا كان this_user true .
  • القيمة الافتراضية limit هي 10 درجات. الحد الأقصى لعدد النقاط التي يمكنك استردادها هو 100 .
  • إذا تم ترك table_id فارغًا، فسيتم إرجاع النتائج من جدول النتائج الأساسي.
  • قم بتمرير this_user على أنه true فقط إذا كنت ترغب في استرداد النتائج الخاصة بالمستخدم الذي تم تعيينه في مُنشئ الفصل فقط. اترك this_user كـ true guest كـ "" لاسترداد كافة النتائج.
  • يسمح لك guest بجلب النتائج حسب اسم ضيف محدد. قم فقط بتمرير إما this_user على أنه true أو guest (أو لا شيء)، وليس كليهما أبدًا.
  • يتم إرجاع النتائج بترتيب اتجاه الفرز في جدول النتائج. على سبيل المثال، بالنسبة للجداول التنازلية، يتم إرجاع الدرجات الأكبر أولاً.

Scores_tables() -> GameJolt

إرجاع قائمة بجداول النتائج العالية للعبة. ينبعث scores_tables_completed .

Scores_add(score,sort,table_id?, Guest?, extra_data?) -> GameJolt

يضيف النتيجة للمستخدم أو الضيف. يصدر scores_add_completed .

  • score: String -> هذه قيمة سلسلة مرتبطة بالنتيجة. مثال: "500 Points" .
  • sort: String|int -> هذه قيمة فرز رقمية مرتبطة بالنتيجة. سيتم إجراء جميع عمليات الفرز على هذا الرقم. مثال : 500 .
  • table_id: String|int (اختياري) -> معرف جدول النتائج المراد الإرسال إليه.
  • guest: String (اختياري) -> اسم الضيف. يتجاوز اسم مستخدم GameJolt المفرد.
  • extra_data: String|int|Dictionary|Array (اختياري) -> إذا كانت هناك أية بيانات إضافية ترغب في تخزينها كسلسلة، فيمكنك استخدام هذا المتغير.

ملحوظات:

  • يمكنك إما تخزين النتيجة لمستخدم أو ضيف. إذا كنت تقوم بالتخزين لمستخدم، فيجب عليك تعيين اسم المستخدم والرمز المميز على المفردة GameJolt وترك guest فارغًا. إذا كنت تقوم بالتخزين لضيف، فيجب عليك تمرير معلمة guest .
  • لا يمكن استرجاع قيمة extra_data إلا من خلال واجهة برمجة التطبيقات (API) ولوحة التحكم الخاصة باللعبة. ولا يتم عرضها علنًا أبدًا للمستخدمين على الموقع. إذا كانت هناك بيانات أخرى مرتبطة بالنتيجة مثل وقت اللعب والعملات المعدنية المجمعة وما إلى ذلك، فيجب عليك تضمينها بالتأكيد. سيكون ذلك مفيدًا في الحالات التي تعتقد فيها أن اللاعب قد حقق درجة عالية بشكل غير قانوني.
  • إذا تم ترك table_id فارغًا، فسيتم إرسال النتيجة إلى جدول الدرجات العالية الأساسي.

Scores_get_rank(sort, table_id?) -> GameJolt

إرجاع تصنيف درجة معينة على جدول النتائج. يصدر scores_get_rank_completed .

  • sort: String|int -> هذه قيمة فرز رقمية يتم تمثيلها برتبة في جدول النتائج.
  • table_id: String|int (اختياري) -> معرف جدول النتائج الذي تريد الحصول على الرتبة منه.

ملحوظات:

  • إذا تم ترك table_id فارغًا، فسيتم إرجاع الرتب من جدول النقاط العالية الأساسي.
  • إذا لم يتم تمثيل النتيجة بأي رتبة في جدول النتائج، فسيقوم الطلب بإرجاع المرتبة الأقرب إلى الدرجة المطلوبة.

الجوائز

troveies_fetch(تم تحقيقه؟, Trophy_ids?) -> GameJolt

تقوم بإرجاع كأس واحد أو عدة جوائز، اعتمادًا على المعلمات trophies_fetch_completed تم تمريرها.

  • sort: bool|null (اختياري) -> تمرير true لإرجاع الجوائز التي تم تحقيقها للمستخدم فقط. قم بالتمرير false لإرجاع الجوائز التي لم يحققها المستخدم فقط. قم بالتمرير null لاسترداد جميع الجوائز.
  • trophy_ids: Array[String|int] (اختياري) -> إذا كنت ترغب في إرجاع كأس واحد أو عدة جوائز، قم بتمرير معرفات الكأس هنا إذا كنت تريد إرجاع مجموعة فرعية من جميع الجوائز.

ملحوظات:

  • سيؤدي تمرير trophy_ids إلى تجاهل المعلمة achieved إذا تم تمريرها.
  • يتطلب تعيين اسم المستخدم والرمز المميز على GameJolt المفرد.

trories_add_achieved(trophy_id) -> GameJolt

يحدد الكأس كما تم تحقيقه لمستخدم معين. يصدر trophies_add_achieved_completed .

  • trophy_id: String|int -> معرف الكأس المراد إضافته للمستخدم.

ملاحظة: يتطلب تعيين اسم المستخدم والرمز المميز على GameJolt المفرد.

groves_remove_achieved(trophy_id) -> GameJolt

إزالة الكأس التي تم تحقيقها مسبقًا لمستخدم معين. يصدر trophies_remove_achieved_completed .

  • trophy_id: String|int -> معرف الكأس المطلوب إزالته من المستخدم.

ملاحظة: يتطلب تعيين اسم المستخدم والرمز المميز على GameJolt المفرد.

تخزين البيانات

data_store_set(key, data, global_data?) -> GameJolt

يضبط البيانات في مخزن البيانات. يصدر data_store_set_completed .

  • key: String -> مفتاح عنصر البيانات الذي ترغب في تعيينه.
  • data: String|Array|Dictionary -> البيانات التي ترغب في تعيينها.
  • global_data: bool (اختياري) -> إذا تم التعيين على true ، فسيتم تجاهل اسم المستخدم والرمز المميز المعين في GameJolt ومعالجة البيانات العامة بدلاً من بيانات المستخدم.

ملحوظات:

  • يمكنك إنشاء عناصر مخزن بيانات جديدة عن طريق تمرير مفتاح غير موجود بعد في مخزن البيانات.
  • إذا كانت global_data false ، فيتطلب تعيين اسم المستخدم والرمز المميز على GameJolt المفرد.

data_store_update(key, Operation, value, global_data?) -> GameJolt

تحديث البيانات في مخزن البيانات. يصدر data_store_update_completed .

  • key: String -> مفتاح عنصر البيانات الذي ترغب في تحديثه.
  • operation: String -> العملية التي ترغب في تنفيذها.
  • value: String|int -> القيمة التي ترغب في تطبيقها على عنصر مخزن البيانات.
  • global_data: bool (اختياري) -> إذا تم التعيين على true ، فسيتم تجاهل اسم المستخدم والرمز المميز المعين في GameJolt ومعالجة البيانات العامة بدلاً من بيانات المستخدم.

ملحوظات:

  • القيم الصالحة operation : "add" و "subtract" و "multiply" و "divide" و "append" و "prepend" .
  • إذا كانت global_data false ، فيتطلب تعيين اسم المستخدم والرمز المميز على GameJolt المفرد.

data_store_remove(key, global_data?) -> GameJolt

يزيل البيانات من مخزن البيانات. يصدر data_store_remove_completed .

  • key: String -> مفتاح عنصر البيانات الذي تريد إزالته.
  • global_data: bool (اختياري) -> إذا تم التعيين على true ، فسيتم تجاهل اسم المستخدم والرمز المميز المعين في GameJolt ومعالجة البيانات العامة بدلاً من بيانات المستخدم.

ملحوظات:

  • إذا كانت global_data false ، فيتطلب تعيين اسم المستخدم والرمز المميز على GameJolt المفرد.

data_store_fetch(key, global_data?) -> GameJolt

إرجاع البيانات من مخزن البيانات. يصدر data_store_fetch_completed .

  • key: String -> مفتاح عنصر البيانات الذي ترغب في جلبه.
  • global_data: bool (اختياري) -> إذا تم التعيين على true ، فسيتم تجاهل اسم المستخدم والرمز المميز المعين في GameJolt ومعالجة البيانات العامة بدلاً من بيانات المستخدم.

ملحوظات:

  • إذا كانت global_data false ، فيتطلب تعيين اسم المستخدم والرمز المميز على GameJolt المفرد.

data_store_get_keys(pattern?, global_data?) -> GameJolt

إرجاع إما جميع المفاتيح الموجودة في مخزن البيانات العالمي للعبة، أو جميع المفاتيح الموجودة في مخزن بيانات المستخدم. يصدر data_store_get_keys_completed .

  • pattern: String (اختياري) -> النمط المطلوب تطبيقه على أسماء المفاتيح في مخزن البيانات.
  • global_data: bool (اختياري) -> إذا تم التعيين على true ، فسيتم تجاهل اسم المستخدم والرمز المميز المعين في GameJolt ومعالجة البيانات العامة بدلاً من بيانات المستخدم.

ملحوظات:

  • إذا قمت بتطبيق نمط على الطلب، فسيتم إرجاع المفاتيح ذات أسماء المفاتيح القابلة للتطبيق فقط. الحرف النائب للأنماط هو "*" .
  • سيعود هذا الطلب قائمة القيم "key" . يمكن أن تظهر قيمة الإرجاع "key" أكثر من مرة.
  • إذا كانت global_data false ، فيتطلب تعيين اسم المستخدم والرمز المميز على GameJolt المفرد.

أصدقاء

الأصدقاء () -> GameJolt

إرجاع قائمة أصدقاء المستخدم. ينبعث friends_completed .

ملاحظة: يتطلب تعيين اسم المستخدم والرمز المميز على GameJolt المفرد.

وقت

الوقت () -> غيم جولت

إرجاع وقت خادم Game Jolt. ينبعث time_completed .

المكالمات الجماعية

الطلب المجمع عبارة عن مجموعة من الطلبات الفرعية التي تمكن المطورين من إرسال استدعاءات متعددة لواجهة برمجة التطبيقات (API) بطلب HTTP واحد. لاستخدام المكالمات المجمعة في التعليمات البرمجية الخاصة بك، قم بإجراء مكالمات الطلب الخاصة بك بين batch_begin و batch_end . على سبيل المثال، استخدم الأساليب الخاصة بك بالترتيب التالي: 

 func _onButtonBatch_pressed () -> void :
    # Begin to gather batch requests
    GameJolt . batch_begin ()

    # Add the time request to the batch
    GameJolt . time ()

    # Add the scores_tables request to the batch
    GameJolt . scores_tables ()

    # Stop gathering batch requests
    GameJolt . batch_end ()

    # Perform the batch call with the two requests above (time and score_tables)
    GameJolt . batch ()
    var result : Dictionary = await GameJolt . batch_completed

دفعة (موازية؟، Break_on_error؟) -> GameJolt

قم بتنفيذ الطلب المجمع بعد تجميع الطلبات باستخدام batch_begin و batch_end . ينبعث batch_completed .

  • parallel: bool (اختياري) -> افتراضيًا، تتم معالجة كل طلب فرعي على الخوادم بالتسلسل. إذا تم تعيين هذا على true ، فستتم معالجة جميع الطلبات الفرعية في نفس الوقت، دون انتظار انتهاء الطلب الفرعي السابق قبل بدء الطلب الفرعي التالي.
  • break_on_error: bool (اختياري) -> إذا تم تعيين هذا على true ، فسيؤدي فشل طلب فرعي واحد إلى توقف الدفعة بأكملها عن معالجة الطلبات الفرعية اللاحقة وإرجاع قيمة false لتحقيق النجاح.

ملحوظات:

  • الحد الأقصى لعدد الطلبات الفرعية في طلب دفعة واحدة هو 50.
  • المعلمات parallel و break_on_error متنافية ولا يمكن استخدامها في نفس الطلب.

Batch_begin()

يبدأ في جمع طلبات الدفعة. لن تقوم الأساليب بإرجاع الاستجابات بعد هذه المكالمة. اتصل بـ batch_end لإنهاء عملية تجميع طلبات الدُفعات.

Batch_end()

توقف عن جمع طلبات الدفعة. سوف تقوم الطرق بإرجاع الاستجابات مرة أخرى بعد هذه المكالمة. يجب استخدامه بعد batch_begin .

يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل