Skip to content

API Specification

Jump to bottom
TuanVuNguyen89 edited this page Aug 23, 2024 · 39 revisions

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 chơi thu hồi item vào balo
  • Tham số: itemId: id của item
  • Trả về: Không có

15. getListChests

List<Obstacle> getListChests()
  • Mô tả: Hàm giúp người chơi lấy ra danh sách thông tin của các rương đồ trên map
  • Tham số: Không có
  • Trả về: Danh sách thông tin các rương đồ

16. getListWeapons

List<Weapon> getListWeapons()
  • Mô tả: Hàm giúp người chơi lấy ra danh sách thông tin của các vũ khí trên map
  • Tham số: Không có
  • Trả về: Danh sách thông tin các vũ khí

17. getListHealingItems

List<getListHealingItems> getListHealingItems()
  • Mô tả: Hàm giúp người chơi lấy ra danh sách thông tin của vật phẩm hồi máu trên map
  • Tham số: Không có
  • Trả về: Danh sách thông tin các vật phẩm hồi máu

18. getListArmors

List<Armor> getListArmors()
  • Mô tả: Hàm giúp người chơi lấy ra danh sách thông tin của vật phẩm giáp trên map
  • Tham số: Không có
  • Trả về: Danh sách thông tin các vật phẩm giáp.

19. getListBullets

List<Bullet> getListBullets()
  • Mô tả: Hàm giúp người chơi lấy ra danh sách thông tin vị trí của vật phẩm đạn trên map
  • Tham số: Không có
  • Trả về: Danh sách các thông tin vật phẩm đạn

20. getOtherPlayerInfo

List<Player> getOtherPlayerInfo()
  • Mô tả: Hàm giúp người chơi lấy ra danh sách thông tin của các người chơi khác trên map
  • Tham số: Không có
  • Trả về: Danh sách thông tin các người chơi khác

21. getCurrentPlayer

Player getCurrentPlayer()
  • Mô tả: Hàm giúp người chơi lấy ra thông tin của người chơi hiện tại
  • Tham số: Không có
  • Trả về: Danh sách thông tin của người chơi hiện tại.
Clone this wiki locally