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

8. move

void move(String move)

• Mô tả: Hàm giúp người dùng di chuyển
• Tham số: move: Một dãy các chỉ dẫn "lrud..." (left - right - up - down) giúp người dùng di chuyển
• Trả về: Không có

9. shoot

void shoot(String direction)

• Mô tả: Hàm giúp người dùng bắn đạn
• Tham số: direction: Hướng sẽ bắn
• Trả về: Không có

10. attack

void attack(String direction)

• Mô tả: Hàm giúp người dùng tấn công cận chiến
• Tham số: direction: Hướng đánh
• Trả về: Không có

11. throwItem

void throwItem(String direction)

• Mô tả: Hàm giúp người bỏ đồ đang cầm trên tay
• Tham số: direction: Bỏ đồ theo hướng
• Trả về: Không có

12. pickupItem

void pickupItem()

• Mô tả: Hàm giúp người chơi nhặt đồ
• Tham số: Không có
• Trả về: Không có

13. useItem

void useItem(String itemId)

• Mô tả: Hàm giúp người chơi sử dụng item
• Tham số: itemId: id của item
• Trả về: Không có

14. revokeItem

void revokeItem(String itemId)

• Mô tả: Hàm giúp người thu hồi item vào balo
• Tham số: itemId: id của item
• Trả về: Không có