Skip to content

/transform

Syntax

/transform <user> <into> <image_url> <channel> <brackets> <copy> <merge>

  • user: A valid Discord User, representing the user to be transformed. If left empty, will transform the user executing the command.

  • into: A string, that will be used as the name of the transformed user.

  • image_url: A valid URL pointing to an image, that will be used as the avatar for the transformed user.

  • channel: A valid Discord Channel. If provided, will make the transformation exclusive to that channel. On the contrary, if it isn't provided, the transformation will apply for all the server's channels, except any that are blocked.

  • brackets: A string with the format of "text". Only works in servers that have enabled this feature, and will make the transformations exclusively happen when the brackets are used, similar to the working principle of TupperBox.

  • copy: A valid Discord User. If provided, will copy the transformation data, including modifiers from said user. All the other parameters can still be provided, and will simply override whatever values the other user had set for them.

Warning

If no into is separately provided, the name of the avatar will have an extra invisible character added to the end of their name, so that their messages don't merge with the original transformed user's. See the Basic Twinning Tutorial for more info.

  • merge: A boolean. Only provide if copy is also provided. Won't have any effect otherwise. It will make it so that copied users do not have the extra invisible character added at the end. See copy parameter for more info.

Usages

This command has three different usages, as described in the Basic TransforMate Tutorial. You can provide only the user, channel, and/or brackets parameters to do a two-step transformation. Providing into and image_url will make a normal transformation, and providing copy, and, optionally, merge, will make a twinning/merging transformation.

Simplified internal logic

flowchart TD
    CommandReceived[Command Received] --> CheckUser[user parameter provided]
    CheckUser --> |False| LoadData[[Load Data]]
    CheckUser --> |True| AssignUser[[user = ctx.user]]
    Database[(Database)] --> LoadData
    AssignUser --> LoadData
    LoadData --> CheckBlocked[[Check if any of the users or the channel is blocked]]
    CheckBlocked --> CheckClaim[[Check that the user to transform isn't claimed or is owned by the transforming user]]
    CheckClaim --> CheckSyntax[[Check that the user provided the correct command syntax for this server's settings]]
    CheckSyntax --> TransformFunction[[transform_function]]
    TransformFunction --> SendAnswer[[Send answer]]

The transform_function

The transform_function is a utility function inside the code of TransforMate that is used through many of the transformation category commands, and contains most of the transformation logic. Following here is an approximation of said logic.

flowchart TD
    CheckIntoProvided[into parameter provided]
    CheckIntoProvided --> |True| CheckIntoSyntax[[Check into syntax]]
    CheckIntoProvided --> |False| CheckImageProvided[image_url parameter provided]
    CheckIntoSyntax --> CheckImageProvided
    CheckImageProvided --> |True| CheckImageSyntax[[Check image_url syntax]]
    CheckImageProvided --> |False| CheckCopyProvided[copy parameter provided]
    CheckImageSyntax --> CheckCopyProvided
    Database[(Database)] --> LoadData[[Load data of user to copy]]
    CheckCopyProvided --> |True| LoadData
    LoadData --> CheckMerge[merge value]
    CheckMerge --> |False| AddInvisible[[Add an invisible character at the end of the name]]
    CheckMerge --> |True| CheckIntoCopy[into parameter provided]
    AddInvisible --> CheckIntoCopy
    CheckIntoCopy --> |True| ChangeIntoCopy[[Change into value for provided]]
    CheckIntoCopy --> |False| CheckImageCopy[image_url parameter provided]
    ChangeIntoCopy --> CheckImageCopy
    CheckImageCopy --> |True| ChangeImageCopy[[Change image_url value for provided]]
    CheckImageCopy --> |False| Transform[[Transform user]]
    ChangeImageCopy --> Transform
    CheckCopyProvided --> |False| CheckInto[into parameter provided]
    CheckInto --> |False| ChangeInto[[Make into be the username]]
    CheckInto --> |True| CheckImage[image_url parameter provided]
    ChangeInto --> CheckImage
    CheckImage --> |False| SecondCheckImage[Does the user have a profile picture?]
    CheckImage --> |True| Transform
    SecondCheckImage --> |False| UseDefaultAvatar[[Use a default Discord avatar]]
    SecondCheckImage --> |True| SetUserPicture[[Make the image_url be the user's Discord profile picture]]
    UseDefaultAvatar --> Transform
    SetUserPicture --> Transform
    Transform --> Log[[Log the transformation]]