API Specification

Tổng Quan SDK Codefest 2024

Tài liệu này liệt kê tổng quan về tất cả các class và method được sử dụng trong bộ SDK của Codefest 2024.

Hero

• Package: jsclub.codefest.sdk.model

• Mô tả: Class chứa các method sử dụng để tạo người chơi cũng như kết nối với Server thi đấu.

Constructor:

Hero(String playerID, String gameID)

• playerID: ID của người chơi.
• gameID: ID của game muốn tham gia.

Methods:

1. connectToServer

Boolean connectToServer(String serverUrl)

• Mô tả: Kết nối người chơi đến Server.
• Tham số:
  • serverUrl: URL của server muốn kết nối đến.
• Trả về:
  • true: Nếu kết nối thành công.
  • false: Nếu kết nối thất bại.

2. start

void start(String serverUrl)

• Mô tả: Kết nối người chơi đến Server.
• Tham số:
  • serverUrl: URL của server muốn kết nối đến.
• Trả về: Không có.

3. getPlayerName

String getPlayerName()

• Mô tả: Trả về tên của người chơi.
• Tham số: Không có.
• Trả về: playerName - Tên của người chơi.

4. getGameID

String getGameID()

• Mô tả: Trả về ID của game.
• Tham số: Không có.
• Trả về: gameID - ID của game.

5. getGameMap

GameMap getGameMap()

• Mô tả: Trả về tất cả thông tin của game.
• Tham số: Không có.
• Trả về: gameMap - Thông tin của game.

6. setOnMapUpdate

void setOnMapUpdate(Emitter.Listener onMapUpdate)

• Mô tả: Bạn cần gọi đến hàm này để cập nhật game theo thời gian thực
• Tham số:
  • Emitter.Listener onMapUpdate : method lắng nghe thông tin từ map
• Trả về: Không có

7. getInventory

Inventory getInventory()

• Mô tả: Lấy thông tin về danh sách vũ khí của người dùng
• Tham số: Không có
• Trả về:
  • Inventory: Danh sách vũ khí của người dùng