Class ScreepsApi

constructor

• new ScreepsApi(config: IConfig): ScreepsApi

  Parameters

  • config: IConfig

  Returns ScreepsApi

socket

console

• console(expression: string, shard: Shard): Promise<IConsole>

  提交代码到控制台

  Parameters

  • expression: string

    代码
  • shard: Shard

  Returns Promise<IConsole>

getGameTime

• getGameTime(shard: Shard): Promise<{ time: number }>

  获取游戏时间

  Parameters

  • shard: Shard

    分片名

  Returns Promise<{ time: number }>

getMapStats

• getMapStats(
      rooms: string[],
      shard: Shard,
      statName: CreepLostType | "owner0",
  ): Promise<IMapStats>

  查询地图数据

  Parameters

  • rooms: string[]
  • shard: Shard
  • statName: CreepLostType | "owner0"

  Returns Promise<IMapStats>

getMarketOrdersIndex

• getMarketOrdersIndex(shard: Shard): Promise<IMarketOrdersIndex>

  获取市场资源信息

  Parameters

  • shard: Shard

  Returns Promise<IMarketOrdersIndex>

getMessage

• getMessage(): Promise<IMessageIndex>

  获取所有消息

  Returns Promise<IMessageIndex>

getMessageByRespondent

• getMessageByRespondent(respondent: string): Promise<IMessageList>

  获取指定 respondent 的消息

  Parameters

  • respondent: string

    会话 id

  Returns Promise<IMessageList>

getMoneyHistory

• getMoneyHistory(): Promise<IScreepsResData>

  获取交易记录

  Returns Promise<IScreepsResData>

getMyInfo

• getMyInfo(): Promise<IMyInfo>

  获取我的信息

  Returns Promise<IMyInfo>

getMyName

• getMyName(): Promise<{ username: string }>

  获取我的名字

  Returns Promise<{ username: string }>

getMyOrders

• getMyOrders(): Promise<IMyOrders>

  获取我的订单

  Returns Promise<IMyOrders>

getNukes

• getNukes(): Promise<INukesData>

  获取 nuker 数据

  Returns Promise<INukesData>

getOrdersByResourceType

• getOrdersByResourceType(
      resourceType: ResourceConstant,
      shard?: Shard,
  ): Promise<IOrders>

  获取指定资源的订单，全局资源不用加 shard 参数

  Parameters

  • resourceType: ResourceConstant

    资源类型
  • Optionalshard: Shard

    分片名

  Returns Promise<IOrders>

getPvp

• getPvp(interval?: number): Promise<IPvpData>

  获取 pvp 数据

  Parameters

  • interval: number = 100

    时间间隔

  Returns Promise<IPvpData>

getRank

• getRank(username: string, mode: "power" | "world"): Promise<IRankList>

  获取某人某赛季排名

  Parameters

  • username: string

    用户名
  • mode: "power" | "world"

    模式，world or power

  Returns Promise<IRankList>
• getRank(
      username: string,
      mode: "power" | "world",
      season: string,
  ): Promise<IRankList>

  获取某人某赛季排名

  Parameters

  • username: string

    用户名
  • mode: "power" | "world"

    模式，world or power
  • season: string

    赛季

  Returns Promise<IRankList>

getRoomObject

• getRoomObject(room: string, shard: Shard): Promise<IRoomObjects>

  获取房间对象

  Parameters

  • room: string

    房间名
  • shard: Shard

    分片名

  Returns Promise<IRoomObjects>

getRoomOverview

• getRoomOverview(
      room: string,
      shard: Shard,
      interval?: Interval,
  ): Promise<IRoomOverview>

  获取房间概览

  Parameters

  • room: string

    房间名
  • shard: Shard

    分片名
  • interval: Interval = 8

    8, 180, 1440 (8 for 1h, 180 for 24h and 1440 for 7 days)

  Returns Promise<IRoomOverview>

getRooms

• getRooms(id: string): Promise<IAllRooms>

  获取指定用户的所有房间（包括预定房间）

  Parameters

  • id: string

    用户 id

  Returns Promise<IAllRooms>

getRoomStatus

• getRoomStatus(room: string, shard: Shard): Promise<IRoomStatus>

  获取房间状态

  Parameters

  • room: string

    房间名
  • shard: Shard

    分片名

  Returns Promise<IRoomStatus>

getRoomTerrain

• getRoomTerrain(room: string, shard: Shard): Promise<IRoomTerrain>

  获取房间地形

  Parameters

  • room: string

    房间名
  • shard: Shard

    分片名

  Returns Promise<IRoomTerrain>
• getRoomTerrain(
      room: string,
      shard: Shard,
      encoded: unknown,
  ): Promise<IRoomTerrainEncoded>

  获取房间地形

  Parameters

  • room: string

    房间名
  • shard: Shard

    分片名
  • encoded: unknown

    是否编码

  Returns Promise<IRoomTerrainEncoded>

getSeasons

• getSeasons(): Promise<ISeasons>

  获取 seasons 数据

  Returns Promise<ISeasons>

getServers

• getServers(): Promise<IServers & { likes: unknown[] }>

  获取服务器列表

  Returns Promise<IServers & { likes: unknown[] }>

getShards

• getShards(): Promise<IAllShardInfo>

  获取各 shard 信息

  Returns Promise<IAllShardInfo>

getUnreadMessageCount

• getUnreadMessageCount(): Promise<IMessageUnRead>

  获取未读消息数量

  Returns Promise<IMessageUnRead>

getUserInfoByUserId

• getUserInfoByUserId(id: string): Promise<IUserInfo>

  查找指定 id 的用户信息

  Parameters

  • id: string

    用户 id

  Returns Promise<IUserInfo>

getUserInfoByUserName

• getUserInfoByUserName(username: string): Promise<IUserInfo>

  查找指定用户名的用户信息

  Parameters

  • username: string

    用户名

  Returns Promise<IUserInfo>

markMessageAsRead

• markMessageAsRead(id: string): Promise<IScreepsResData>

  标记消息为已读

  Parameters

  • id: string

    消息 id

  Returns Promise<IScreepsResData>

sendMessage

• sendMessage(respondent: string, text: string): Promise<IScreepsResData>

  发送消息

  Parameters

  • respondent: string

    会话 id
  • text: string

    消息内容

  Returns Promise<IScreepsResData>