Skip to content
This repository has been archived by the owner on Feb 22, 2024. It is now read-only.

Latest commit

 

History

History
360 lines (269 loc) · 8.03 KB

API.md

File metadata and controls

360 lines (269 loc) · 8.03 KB
Raw

Methods

achievements() ⇒ Promise

User achievements.

askPassCode(email) ⇒ Promise

Ask a passCode to login into the game.

authenticate() ⇒ Console

Get your account token easily.

building(id) ⇒ Promise

A building info.

claimCode(code) ⇒ Promise

Claim a code.

common() ⇒ Promise

Common game info.

currencies(id) ⇒ Promise

Cryptocurrencies list of a building.

dailyRewards() ⇒ Promise

User daily Rewards list.

division(league_id, division_id) ⇒ Promise

A division players list.

emptyData ⇒ Object

Empty user data.

gameCharacters() ⇒ Promise

GameCharacters list.

leagues() ⇒ Promise

Leagues list.

login(email, passCode) ⇒ Promise

Login with a passCode to the game.

lookup(id) ⇒ Promise

An user info.

newUser(data) ⇒ Promise

Create a user on the server.

referrals() ⇒ Promise

User referrals.

researches() ⇒ Promise

Researches list.

user() ⇒ Promise

User info.

userLeaderboard() ⇒ Promise

User leaderboard.

updateUserData(data) ⇒ Promise

Update user data on the server.

updateUserInstallation(appVersion, deviceId, deviceToken, deviceType) ⇒ Promise

Update user installtion on the server.

withdraw(address, amount) ⇒ Promise

Ask for a withdraw of your HORA tokens.

achievements ⇒ Promise

User achievements.

Kind: property
Returns: Promise

askPassCode(email) ⇒ Promise

Ask a passCode to login into the game.

Kind: method
Returns: Promise

Param Type Description
email String user email

Example

askPassCode("lockblock@test.test")

authenticate() ⇒ Console

get your account token easily.

Kind: method
Returns: Console - authenticate in the console
Example

authenticate()

building(id) ⇒ Promise

a building info.

Kind: method
Returns: Promise

Param Type Description
id Number building id

Example

building(2)

claimCode(code) ⇒ Promise

Claim a code.

Kind: method
Returns: Promise

Param Type Description
code String code

Example

claimCode("TEST500")

common ⇒ Promise

Common game info.

Kind: property
Returns: Promise

currencies(id) ⇒ Promise

cryptocurrencies list of a building.

Kind: method
Returns: Promise

Param Type Description
id Number building id

Example

currencies(2)

dailyRewards ⇒ Promise

User daily Rewards list.

Kind: property
Returns: Promise

division(league_id, division_id) ⇒ Promise

a division players list.

Kind: method
Returns: Promise

Param Type Description
league_id Number league id
division_id Number division id

Example

division(2, 50)

emptyData ⇒ Object

Empty user data.

Kind: property
Returns: Object

gameCharacters ⇒ Promise

GameCharacters list.

Kind: property
Returns: Promise

leagues ⇒ Promise

Leagues list.

Kind: property
Returns: Promise

login(email, passCode) ⇒ Promise

Login with a passCode to the game.

Kind: method
Returns: Promise

Param Type Description
email String user email
passCode String passCode sent to the email

Example

login("lockblock@test.test", "123456")

lookup(id) ⇒ Promise

an user info.

Kind: method
Returns: Promise

Param Type Description
id String user id

Example

lookup("1t1551uq18662v0rq0630tu9")

newUser(data) ⇒ Promise

Create a user on the server.

Kind: method
Returns: Promise

Param Type Description
data Object empty user data

Example

newUser(client.emptyData)

referrals ⇒ Promise

User referrals.

Kind: property
Returns: Promise

researches ⇒ Promise

Researches list.

Kind: property
Returns: Promise

user ⇒ Promise

User info.

Kind: property
Returns: Promise

userLeaderboard ⇒ Promise

User leaderboard.

Kind: property
Returns: Promise

updateUserData(data) ⇒ Promise

Update user data on the server.

Kind: method
Returns: Promise
Warning: use this at your own risk !

Param Type Description
data Object user data

Example

updateUserData(data)

updateUserInstallation(appVersion, deviceId, deviceToken, deviceType) ⇒ Promise

Update user installtion on the server.

Kind: method
Returns: Promise
Warning: use this at your own risk !

Param Type Description
appVersion String game version
deviceId String device id
deviceToken String device token
deviceType String device type

Example

updateUserInstallation("1.6.10", "5112096s844v9q37qu81t0620q0u923v", "", "Android OS 11")

withdraw(address, amount) ⇒ Promise

Ask for a withdraw of your HORA tokens.

Kind: method
Returns: Promise

Param Type Description
address String TRON wallet address
amount Number amount of HORA

Example

withdraw("TNjt5fShPVJ4YpsLuU4THuBbg58g2bZoLk", 10000)