# Format Number

Grammar — Format Number(number)
Flags — Native | Function

Formats a number into a localization friendly text value. For example, 1000000 will become 1,000,000 in English.

# Arguments

• int — Number

Returns — text

native text FormatNumber(int number);

# Related

Category: Conversion / Basic Conversions

• [F] — text — Convert String To Text — ( StringToText )
• [F] — string — Convert Game Link To String — ( )
• [F] — string [ gamelink ] — Convert String To Game Link — ( )
• [F] — string [ catalogentry ] — Convert String To Catalog Entry — ( )
• [F] — string [ reference ] — Convert String To Catalog Reference — ( )
• [F] — string [ catalogfieldname ] — Convert String To Catalog Field Name — ( )
• [F] — string [ catalogfieldpath ] — Convert String To Catalog Field Path — ( )
• [F] — string [ catalogscope ] — Convert String To Catalog Scope — ( )
• [F] — string — Convert Catalog Entry To String — ( )
• [F] — string — Convert Catalog Reference To String — ( )
• [F] — string [ reference ] — Convert Catalog Reference (Any -> Numeric) — ( )
• [F] — string [ reference ] — Convert Catalog Reference (Any -> Upgrade) — ( )
• [F] — string [ reference ] — Convert Catalog Reference (Upgrade -> Any) — ( )
• [F] — string [ reference ] — Convert Catalog Reference (Numeric -> Any) — ( )
• [F] — string — Convert Catalog Field Name To String — ( )
• [F] — string — Convert Catalog Field Path To String — ( )
• [F] — string — Convert Catalog Scope To String — ( )
• [F] — string [ filepath ] — Convert String To Image File — ( )
• [F] — string [ filepath ] — Convert String To Movie File — ( )
• [F] — string [ filepath ] — Convert String To Cutscene File — ( )
• [F] — string — Convert Conversation State Index To String — ( )
• [F] — string [ convstateindex ] — Convert String To Conversation State Index — ( )
• [F] — string — Convert User Data Instance To String — ( )
• [F] — string [ userinstance ] — Convert String To User Data Instance — ( )
• [F] — fixed — Convert String To Real — ( StringToFixed )
• [F] — int — Convert String To Integer — ( StringToInt )
• [F] — abilcmd — Convert String To Ability Command — ( StringToAbilCmd )
• [F] — text — Convert Real To Text — ( FixedToText )
• [F] — text — Convert Real To Text (Advanced) — ( FixedToTextAdvanced )
• [F] — string — Convert Real To String — ( FixedToString )
• [F] — int — Convert Real To Integer — ( FixedToInt )
• [F] — text — Convert Integer To Text — ( IntToText )
• [F] — string — Convert Integer To String — ( IntToString )
• [F] — fixed — Convert Integer To Real — ( IntToFixed )
• [F] — text — Convert Boolean To Text — ( libNtve_gf_ConvertBooleanToText )
• [F] — int — Convert Boolean To Integer — ( BoolToInt )
• [F] — string — Convert Boolean To String — ( libNtve_gf_ConvertBooleanToString )
• [F] — bool — Convert String To Boolean — ( libNtve_gf_ConvertStringToBoolean )
• [F] — string — Convert Point To String — ( libNtve_gf_ConvertPointToString )
• [F] — point — Convert String To Point — ( libNtve_gf_ConvertStringToPoint )
• [F] — string — Convert Image To String — ( )
• [F] — int — Convert Game User To Integer — ( )
• [F] — text — Format Number — ( FormatNumber )
• [F] — text — Format Duration — ( FormatDuration )

# Examples

# campaigns/liberty.sc2campaign

— MapScript.galaxy

// L3780
FormatNumber(gv_score)

// L3781
FormatNumber(gv_highScore)

// L4526
FormatNumber(gv_salvageTotal)

// L4527
FormatNumber(gv_mineralsHarvested)

// L4528
FormatNumber(gv_spiderMineKillCount)

// L4368
FormatNumber((PlayerScoreValueGetAsInt(gv_p01_USER, "MineralsCollected") + gv_mineralsFromPickups))

// L3780
FormatNumber(gv_score)

// L3781
FormatNumber(gv_highScore)

// L4526
FormatNumber(gv_salvageTotal)

// L4527
FormatNumber(gv_mineralsHarvested)

// L4528
FormatNumber(gv_spiderMineKillCount)

// L4368
FormatNumber((PlayerScoreValueGetAsInt(gv_p01_USER, "MineralsCollected") + gv_mineralsFromPickups))

# campaigns/libertystory.sc2campaign

— CampaignLib.galaxy

// L2958
FormatNumber(lp_credits)

# mods/heroes.stormmod

— MapScript.galaxy

// L1306
FormatNumber(FixedToInt(gv_targetDummyDamageLastSecond))

// L1306
FormatNumber(FixedToInt(gv_targetDummyDamageLastSecond))

# mods/heroesdata.stormmod

— GameLib.galaxy

// L3158
FormatNumber(FixedToInt(lv_awardValue))

// L3160
FormatNumber(FixedToInt(libGame_gv_mVPStats[lp_playerIndex].lv_deaths))

# mods/heroesdata.stormmod

— StartingExperienceLib.galaxy

// L5341
FormatNumber(FixedToInt(lv_damage))

// L5343
FormatNumber(FixedToInt(lv_damage))

// L5346
FormatNumber(FixedToInt((lv_damage / TimerGetElapsed(libStEx_gv_targetDummyDamageTimer))))

# mods/heroesdata.stormmod

— UILib.galaxy

// L15410
FormatNumber(FixedToInt(lv_prioritizedXPVauleList[0]))

// L15411
FormatNumber(FixedToInt(lv_prioritizedXPVauleList[1]))

// L15412
FormatNumber(FixedToInt(lv_prioritizedXPVauleList[2]))

// L15413
FormatNumber(FixedToInt(lv_prioritizedXPVauleList[3]))

// L15414
FormatNumber(FixedToInt(lv_prioritizedXPVauleList[4]))

// L15415
FormatNumber(FixedToInt(lv_totalXPContribution))

// L15438
FormatNumber(FixedToInt(lv_prioritizedXPVauleList[0]))

// L15439
FormatNumber(FixedToInt(lv_prioritizedXPVauleList[1]))

// L15440
FormatNumber(FixedToInt(lv_prioritizedXPVauleList[2]))

// L15441
FormatNumber(FixedToInt(lv_prioritizedXPVauleList[3]))