SCR_ByteFormat Interface Reference

Static Public Member Functions
static string	ReadableSizeFromBytes (out float value, int decimals=1)
	Return byte size in 3 digid max format with included size name up to GB.
static string	GetReadableSize (float value, int decimals=1)
	Return byte size in 3 digid max format with included size name up to GB: 123 B, 123 kB, 123 MB, 123 GB.
static string	GetReadableSizeMb (float value)
	Returns byte size in megabytes, rounded to nearest MB.
static string	ContentDownloadFormat (float value)
	Displays KB and MB in 0.0 and GB in 0.000 to better display progress.

Static Public Attributes
const static float	BYTE_UNIT_SIZE = 1024.0
const static string	FORMAT_B ="#AR-DataSize_B"
const static string	FORMAT_KB ="#AR-DataSize_kB"
const static string	FORMAT_MB ="#AR-DataSize_MB"
const static string	FORMAT_GB = "#AR-DataSize_GB"

Member Function Documentation

ContentDownloadFormat()

static string SCR_ByteFormat.ContentDownloadFormat ( float  value )

static

Displays KB and MB in 0.0 and GB in 0.000 to better display progress.

GetReadableSize()

static string SCR_ByteFormat.GetReadableSize ( float  value, int  decimals = 1  )

static

Return byte size in 3 digid max format with included size name up to GB: 123 B, 123 kB, 123 MB, 123 GB.

GetReadableSizeMb()

static string SCR_ByteFormat.GetReadableSizeMb ( float  value )

static

Returns byte size in megabytes, rounded to nearest MB.

If size is lower than 1 MB, it is rounded to nearest 0.1 MB: 0.6 MB.

ReadableSizeFromBytes()

static string SCR_ByteFormat.ReadableSizeFromBytes ( out float  value, int  decimals = 1  )

static

Return byte size in 3 digid max format with included size name up to GB.

Member Data Documentation

BYTE_UNIT_SIZE

const static float SCR_ByteFormat.BYTE_UNIT_SIZE = 1024.0

static

FORMAT_B

const static string SCR_ByteFormat.FORMAT_B ="#AR-DataSize_B"

static

FORMAT_GB

const static string SCR_ByteFormat.FORMAT_GB = "#AR-DataSize_GB"

static

FORMAT_KB

const static string SCR_ByteFormat.FORMAT_KB ="#AR-DataSize_kB"

static

FORMAT_MB

const static string SCR_ByteFormat.FORMAT_MB ="#AR-DataSize_MB"

static

---

The documentation for this interface was generated from the following file:

• Game/Utilities/SCR_ByteFormat.c