events 活动

活动信息获取模块。

python

from bestdori import events

类型定义

EventInfo 活动信息

活动详细信息字典。 all.{index}.json 信息字典为该字典中选取部分字段信息。

字段名	类型	描述
eventName	List[str \| None]	活动名定长列表
eventType	str	活动类型
assetBundleName	str	资源库名称
startAt	List[str \| None]	活动起始时间戳定长列表
endAt	List[str \| None]	活动终止时间戳定长列表
rewardCards	List[int]	活动奖励卡牌 ID 列表
attributes	List[Attribute]	活动加成属性列表
characters	List[Character]	活动加成角色列表
eventAttributeAndCharacterBonus NotRequired	EventAttributeAndCharacterBonus	活动属性与角色加成
eventCharacterParameterBonus NotRequired	EventCharacterParameterBonus	活动角色数值加成
members	List[Member]	-
limitBreaks	List[LimitBreak]	-
enableFlag	List[Literal[True] \| None]	活动是否可用定长列表
publicStartAt	List[str \| None]	活动公开起始时间戳定长列表
publicEndAt	List[str \| None]	活动公开终止时间戳定长列表
distributionStartAt	List[str \| None]	发布起始时间戳定长列表
distributionEndAt	List[str \| None]	发布结束时间戳定长列表
bgmAssetBundleName	str	BGM 资源库名称
bgmFileName	str	BGM 资源文件名称
aggregateEndAt	List[str \| None]	结果汇总结束时间戳定长列表
exchangeEndAt	List[str \| None]	交换所结束时间戳定长列表
pointRewards	List[List[PointReward] \| None]	点数奖励列表定长列表
rankingRewards	List[List[RankingReward] \| None]	排名奖励列表定长列表
stories	List[Story]	活动故事列表
musics	List[Music]	活动音频列表

Attribute 活动加成属性信息

字段名	类型	描述
eventId NotRequired	int	活动 ID
attribute	str	活动加成属性
percent	int	加成百分比

Character 活动加成角色信息

字段名	类型	描述
eventId NotRequired	int	活动 ID
characterId	int	活动加成角色 ID
percent	int	加成百分比
seq NotRequired	int	-

EventAttributeAndCharacterBonus

字段名	类型	描述
eventId NotRequired	int	活动 ID
pointPercent	int	-
parameterPercent	int	-

EventCharacterParameterBonus

字段名	类型	描述
eventId NotRequired	int	活动 ID
performance	int	-
technique	int	-
visual	int	-

Member

字段名	类型	描述
eventId	int	活动 ID
situationId	int	-
percent	int	-
seq	int	-

LimitBreak

字段名	类型	描述
rarity	int	-
rank	int	-
percent	float	-

PointReward

字段名	类型	描述
point	str	点数
rewardType	str	奖励类型
rewardId NotRequired	int	奖励 ID
rewardQuantity	int	奖励数量

RankingReward

字段名	类型	描述
fromRank	int	奖励起始排名
toRank	int	奖励终止排名
rewardType	str	奖励类型
rewardId NotRequired	int	奖励 ID
rewardQuantity	int	奖励数量

Story 活动故事

字段名	类型	描述
scenarioId	str	场景 ID
coverImage	str	封面图片链接
backgroundImage	str	背景图片链接
releasePt	str	解锁所需点数
rewards	List[StoryReward]	故事奖励
caption	List[str \| None]	故事说明定长列表
title	List[str \| None]	故事标题定长列表
synopsis	List[str \| None]	故事简介定长列表
releaseConditions	List[str \| None]	解锁条件定长列表

StoryReward

字段名	类型	描述
rewardType	str	奖励类型
rewardId NotRequired	int	奖励 ID
rewardQuantity	int	奖励数量

Music 活动歌曲

字段名	类型	描述
musicId	int	歌曲 ID
musicRankingRewards	List[MusicRankingReward]	歌曲排名奖励

MusicRankingReward

字段名	类型	描述
fromRank	int	奖励起始排名
toRank	int	奖励终止排名
resourceType	str	资源类型
resourceId	int	资源 ID
Quantity	int	数量

def get_all() async

参数名	类型	默认值	描述
index	int	`0`	指定获取的 `JSON` 信息
me keyword	Optional[Me]	`None`	登录用户类

获取总活动信息，返回以活动 ID 为字段名、 EventsAllInfo 为字段值的信息字典， EventsAllInfo 为从 EventInfo 中截取出的部分信息。根据 index 参数值不同，获取到的 EventsAllInfo 所包含的信息也不同。

特别地，当 index 值为 0 时，返回值为以活动 ID 为字段名、 NoneDict 为字段值的字典

index 可用参数值

参数值	获取字段值末项字段名
0	-
1	`eventName`
3	`endAt`
4	`rewardCards`
5	`limitBreaks`
6	`limitBreaks`

返回值: Dict[str, EventsAllInfo | NoneDict]

class Event()

活动类，包含各种活动相关资源整合。

def init()

参数名	类型	默认值	描述
id	int	-	活动 ID
me keyword	Optional[Me]	`None`	登录用户类

def tracker()

参数名	类型	默认值	描述
server	Server	-	服务器 ID

获取活动的 PT 与排名追踪器。

返回值: EventTracker

def get_info() async

获取活动信息。

返回值: EventInfo

def get_comment() async

参数名	类型	默认值	描述
limit	int	20	获取到的帖子数量上限
offset	int	0	获取帖子时的偏移量
order	Order	`'TIME_ASC'`

获取活动的社区评论列表。

返回值: PostList

参数名	类型	默认值	描述
server	ServerName	-	服务器名

获取活动缩略图资源。

返回值: bytes

def get_logo() async

参数名	类型	默认值	描述
server	ServerName	-	服务器名

获取活动 LOGO 资源。

返回值: bytes

def get_topscreen() async

参数名	类型	默认值	描述
server	ServerName	-	服务器名
type	str	-	主界面图像类型

type 可用参数值

值	描述
`'bg'`	背景全图
`'trim'`	角色图像

获取活动主界面图像资源。

返回值: bytes

def get_stamp() async

获取活动奖励稀有表情资源。

返回值: bytes

def get_top() async

该方法存在多种调用方式：

获取最终 T10 排名分数线

参数名	类型	默认值	描述
server	Server	-	服务器 ID
mid	int	0	歌曲 ID 。仅在查询歌曲分数排名时为非 `0` 值
latest keyword	Literal[1]	-	表示获取最终排名分数线

获取最终 T10 排名分数线。

获取最新 T10 排名分数线

参数名	类型	默认值	描述
server	Server	-	服务器 ID
mid	int	0	歌曲 ID 。仅在查询歌曲分数排名时为非 `0` 值
interval keyword	int	-	获取最新分数线间隔

获取最新 T10 排名分数线。

返回值: EventTopData

def get_rotation_musics() async

获取团队 LIVE 佳节活动歌曲循环数据 FestivalRotationMusic 。仅在活动类型为团队 LIVE 佳节活动时有效。

返回值: List[FestivalRotationMusic]

def get_stages() async

获取团队 LIVE 佳节活动舞台数据 FestivalStage 。仅在活动类型为团队 LIVE 佳节活动时有效。

返回值: List[FestivalStage]

events 活动 ​

类型定义 ​

EventInfo 活动信息 ​

Attribute 活动加成属性信息 ​

Character 活动加成角色信息 ​

EventAttributeAndCharacterBonus ​

EventCharacterParameterBonus ​

Member ​

LimitBreak ​

PointReward ​

RankingReward ​

Story 活动故事 ​

StoryReward ​

Music 活动歌曲 ​

MusicRankingReward ​

def get_all() async ​

class Event() ​

def init() ​

def tracker() ​

def get_info() async ​

def get_comment() async ​

def get_banner() async ​

def get_logo() async ​

def get_topscreen() async ​

def get_stamp() async ​

def get_top() async ​

def get_rotation_musics() async ​

def get_stages() async ​

events 活动

类型定义

EventInfo 活动信息

Attribute 活动加成属性信息

Character 活动加成角色信息

EventAttributeAndCharacterBonus

EventCharacterParameterBonus

Member

LimitBreak

PointReward

RankingReward

Story 活动故事

StoryReward

Music 活动歌曲

MusicRankingReward

def get_all() async

class Event()

def init()

def tracker()

def get_info() async

def get_comment() async

def get_banner() async

def get_logo() async

def get_topscreen() async

def get_stamp() async

def get_top() async

def get_rotation_musics() async

def get_stages() async