🛠️Utility Functions

You can find some functions here that can help with quickly creating avatars or getting useful information.

def create_avatar()

Create a DAvatar object and return it.

def create_avatar(
    style: DStyle,
    seed: str,
    options: DOptions | None = None,
    customisations: dict | None = None
) -> DAvatar

Returns: a new DAvatar object

Parameter	Type	Default	Description
style	DStyle	DStyle.random()	The style of avatar you want to create (Styles)
seed	str	None	Base string to determine the avatar.
options	DOptions	DOptions.empty	General options for the avatar.
customisations	dict	None	Customisations (for the chosen style)

def create_random()

Create a random DAvatar object and return it.

def create_random(
    randomOptions: bool = False
) -> DAvatar

Returns: a new DAvatar object

Parameter	Type	Default	Description
randomOptions	bool	False	Whether to use random (background) options for this avatar or not

def bulk_create()

Create a list of DAvatar objects (with random seeds).

def bulk_create(
    style: DStyle = DStyle.random(),
    amount: int = 2,
    *,
    options: DOptions = DOptions.default,
    custom: dict = None
) -> list[DAvatar]

Returns: list[DAvatar]: a list of DAvatar objects

Parameter	Type	Default	Description
style	DStyle	DStyle.random()	The style you want to create (Styles)
amount	int	2	The amount of DAvatar objects you want to create.
options	DOptions	DOptions.empty	General options for the avatars.
custom	dict	None	Customisations (for the chosen style)