Overview

Classes

  • Card
  • CardRegular
  • Component
  • ComponentAvatar
  • ComponentFlag
  • ComponentImage
  • ComponentLabel
  • ComponentXPBar
  • ErrorImage
  • OsuAPI
  • OsuSignature
  • PredefinedColours
  • Signature
  • Template
  • TemplateNormal
  • Utils
  • Overview
  • Class

Overview

Classes summary
Card

The background of each template - these are reusable. These are instantiated in a Template's constructor and are drawn prior to the components.

CardRegular The background card of the original osu!nextsig design.
Component

An element in the signature. These are used for things like labels, avatars etc. A signature's width is calculated by the size of its elements.

ComponentAvatar The avatar component. This fetches the avatar from ComponentAvatar::AVATAR_URL using the user's UID.
ComponentFlag The flag component. Looks for a country flag in ComponentFlag::FLAGS_DIRECTORY based on the user's country code.
ComponentImage Simple image component.
ComponentLabel The label component, used to display text.
ComponentXPBar A level/xp bar component.
ErrorImage Generates an error image to die with.
OsuAPI A class to access the osu! API. It queries the API at OsuAPI::API_URL.
OsuSignature The osu! signature object.
PredefinedColours An array of named colours for backwards compatibility.
Signature The base signature object, initialising the canvas and outputting it.
Template A template for signatures. This predefines the background Card and Components.
TemplateNormal

The original osu!nextsig signature card. This is the design that followed through from v1 to v3. This is a pretty messy class.

Utils Small utility class.
API documentation generated by ApiGen