| |
class Waifu() |
| |
Represents a waifu from mudae.
A class nested in the Mudae class.
Objects from this class should not be created directly but through a Mudae object
A lot of the attributes will often be null since they either:
a. Are not applicable
b. Can't be read from the waifu message
c. Need to be fetched with the methods
Attributes
----------
mudae: discord.User
The mudae bot that created this waifu.
user: discord.Client
The client that's using this waifu.
message: discord.Message
The waifu message the waifu came from.
owner: discord.Member
The member whose harem the waifu belongs to.
creator: discord.Member
The member that rolled this waifu.
suitors: list[discord.Member]
A list of members who wished the waifu.
name: str
The name of the waifu.
series: str
The series the waifu belongs to.
kakera: int
The kakera value of the waifu.
key: int
The key level of the waifu.
claims: int
The claims rank of the waifu.
likes: int
The likes rank of the waifu
type: Mudae.Waifu.Type
The type of the waifu.
image: str
URL of the image, that the waifu message had, when the object was created.
image_count: int
How many images the waifu has available in total.
image_index: int
Image index of the image attribute with respect to the avaliable images.
image_extra: int
How many extra images have been added to the waifu.
is_claimed: bool
If the waifu has been claimed yet.
is_roll: bool
If the waifu is a roll.
is_girl: bool
If the waifu is female or both female and male.
Methods
-------
async fetch_extra()
Fills the suitor and creator attributes.
async await_claim()
Waits for a member to claim this waifu, then returns with that member.
|
| |
- async await_claim()
- Waits for a member to claim this waifu, then returns with that member.
If the waifu has already been claimed, the owner is returned immediately.
If the waifu doesn't have an owner, the function will wait for up to 60s for someone to claim.
Returns none if after 60s no one has claimed.
Returns
-------
Mudae.Waifu
The waifu has an owner or one is found.
None
No owner could be found, the waifu wasn't claimed within 60s.
- async fetch_extra()
- Fills the suitor and creator attributes.
The suitor and creator attributes are by default empty and null respectively. To get the real values, this method must be called.
The method will only work for waifus of type roll and only if the waifu was just rolled.
- enum Type
- Represents the different types of waifus.
Enums
-----
roll: 0
The waifu was rolled e.g. created with $w.
info: 1
The waifu came from the info command e.g. created with $im.
| |