• Parameters

    • displayName: {
          hidden: boolean;
          sourceType: "nameTag" | "name" | "hidden" | "sudo";
          value?: string;
      }
    • Optionaloptions: {
          currentHealth?: number;
          isPlaceholderPlayer?: boolean;
          maxHealth?: number;
          nameFormatting?: string;
          nameGradientMode?: string;
          player?: Player;
          playerPersonalSettings?: {
              chatRankPrefix?: string;
              defaultNameFormatting?: string;
              rankDisplayPrefix?: string;
              rankDisplaySeparator?: string;
              rankDisplaySuffix?: string;
          };
          ranks?: string[];
          showHealth?: boolean;
          tags?: string[];
      }

    Returns {
        currentHealth: number;
        displayName: {
            hidden: boolean;
            sourceType: "nameTag" | "name" | "hidden" | "sudo";
            value?: string;
        };
        maxHealth: number;
        name: string;
        nameFormatting: string;
        nameGradientMode: string;
        rank: string;
        ranksListWithDefault: string[];
        showHealth: boolean;
    }