# Purchase Mercenary

Grammar — Purchase mercenaryId
Flags — Native | Action

Convenience function to mark the specified mercenary as purchased, recently purchased, and play the purchase animation on it.

# Arguments

• int [ preset::Mercenary ] — MercenaryId

Returns — void

native void MercenaryPurchase(int inMercenaryId);

# Related

Category: Story / Mercenary Panel

• [F] — void — Mercenary Panel Exited — ( TriggerAddEventMercenaryPanelExit )
• [F] — void — Mercenary Panel Purchase — ( TriggerAddEventMercenaryPanelPurchase )
• [F] — void — Mercenary Panel Selection Changed — ( TriggerAddEventMercenaryPanelSelectionChanged )
• [F] — void — Create Mercenary — ( MercenaryCreate )
• [F] — int [ preset::Mercenary ] — Last Created Mercenary — ( MercenaryLastCreated )
• [F] — void — Destroy Mercenary — ( MercenaryDestroy )
• [F] — void — Set Mercenary Title Text — ( MercenarySetTitleText )
• [F] — void — Set Mercenary Unit Text — ( MercenarySetUnitText )
• [F] — void — Set Mercenary CostText — ( MercenarySetCostText )
• [F] — void — Set Mercenary Description Text — ( MercenarySetDescriptionText )
• [F] — void — Set Mercenary Special Text — ( MercenarySetSpecialText )
• [F] — void — Set Mercenary Availability Text — ( MercenarySetAvailabilityText )
• [F] — void — Set Mercenary Cost — ( MercenarySetCost )
• [F] — void — Set Mercenary State — ( MercenarySetState )
• [F] — void — Set Mercenary Portrait Image — ( MercenarySetImageFilePath )
• [F] — void — Set Mercenary Portrait Model — ( MercenarySetModelLink )
• [F] — void — Set Mercenary Scene — ( MercenarySetScenePath )
• [F] — void — Set Mercenary Player Group — ( MercenarySetPlayerGroup )
• [F] — void — Set Mercenary Recently Purchased — ( MercenarySetRecentlyPurchased )
• [F] — bool — Mercenary Is Recently Purchased — ( MercenaryIsRecentlyPurchased )
• [F] — void — Purchase Mercenary — ( MercenaryPurchase )
• [F] — void — Set Selected Mercenary — ( MercenarySetSelected )
• [F] — void — Enable/Disable Mercenary Panel Close Button — ( MercenaryPanelSetCloseButtonEnabled )
• [F] — void — Enable/Disable Mercenary Panel Dismiss Button — ( MercenaryPanelSetDismissButtonEnabled )
• [F] — int [ preset::Mercenary ] — Selected Mercenary — ( MercenaryGetSelected )

# Examples

# campaigns/libertystory.sc2campaign

— CampaignLib.galaxy

// L3807
MercenaryPurchase(libCamp_gv_tS_MercUIMercenaries[(lp_mercGifted)])

// L12212
MercenaryPurchase(libCamp_gv_tS_MercUIMercenaries[(lv_mercBought)])