Difference between revisions of "LUA:GetLootCoin"

(New page: == LUA Functions: GetLootCoin(param) == Need info Back to LUA Functions Index === Syntax === var = GetLootCoin(param) === Parameters === Required: ''par...)
 
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== LUA Functions: GetLootCoin(param) ==
+
{{PageHeaderChild|LUA|GetLootCoin}}
Need info
 
  
[[Developer:LUA_Functions | Back to LUA Functions Index]]
+
= LUA Functions: GetLootCoin() =
 +
Gets the given spawns loot coins
  
  
=== Syntax ===
+
==== Syntax ====
var = GetLootCoin(param)  
+
var = GetLootCoin(param1)
  
  
=== Parameters ===
+
==== Parameters ====
Required: ''param'' (int)
+
; Required - ''param1'' (Spawn)
 +
: ''param1'' is the spawn who's loot coins we want to get
  
  
=== Notes ===
+
==== Returns ====
''param'' must be one of the vars in the function params. In the example below, it would be either "NPC" or "Spawn"
+
; int32
 +
: The amount of loot coins
  
  
=== Usage ===
+
==== Usage ====
Need example usage
+
<pre>
 +
function hailed(NPC, Spawn)
 +
    local coins = GetLootCoin(NPC)
 +
    Say(NPC, "I have " .. coins .. "coins")
 +
end
 +
</pre>
 +
 
 +
When the NPC is hailed it will Say() how many loot coins it has

Latest revision as of 17:18, 9 August 2016

LUA - GetLootCoin

Return to: LUA | Tutorials | Portal | Forum | Project Manager | Bug Tracker


LUA Functions: GetLootCoin()

Gets the given spawns loot coins


Syntax

var = GetLootCoin(param1)


Parameters

Required - param1 (Spawn)
param1 is the spawn who's loot coins we want to get


Returns

int32
The amount of loot coins


Usage

function hailed(NPC, Spawn)
    local coins = GetLootCoin(NPC)
    Say(NPC, "I have " .. coins .. "coins")
end

When the NPC is hailed it will Say() how many loot coins it has