LUA:AddPrimaryEntityCommand - Revision history

Cynnar at 21:44, 30 January 2021

2021-01-30T21:44:00Z

Cynnar at 21:43, 30 January 2021

2021-01-30T21:43:11Z

Cynnar at 21:42, 30 January 2021

2021-01-30T21:42:44Z

Cynnar at 19:03, 30 January 2021

2021-01-30T19:03:34Z

Jabantiz: Created page with "= LUA Functions: AddPrimaryEntityCommand() = Returns the current '''current hit points''' of ''param''. The parameter can be either a player or the NPC currently being interacted..."

2012-10-15T23:40:33Z

Created page with "= LUA Functions: AddPrimaryEntityCommand() = Returns the current '''current hit points''' of ''param''. The parameter can be either a player or the NPC currently being interacted..."

New page

= LUA Functions: AddPrimaryEntityCommand() =
Returns the current '''current hit points''' of ''param''. The parameter can be either a player or the NPC currently being interacted with.

==== Syntax ====
AddPrimaryEntityCommand(param1, param2, param3, [param4], [param5], [param6], [param7], [param8])

==== Parameters ====
; Required - ''param1'' (spawn), ''param2'' (spawn), ''param3'' (string)
: ''param1'' is the player who will see this new command on the given spawn, must be a player
: ''param2'' is the spawn that will get the new command
: ''param3'' is the name of the command

; Optional - ''param4'' (float), ''param5'' (string), ''param6'' (string), ''param7''(int16), ''param8'' (int32)
: ''param4'' is the max distance from the spawn to be able to use the command
: ''param5'' is the command
: ''param6'' is the error text for when the command fails
: ''param7'' is the time it takes to cast the command
: ''param8'' is the spell visual for this command

==== Usage ====
<pre>
function hailed(NPC, Spawn)
AddPrimaryEntityCommand(Spawn, NPC, "poke")
end
</pre>

Add the poke command to the spawn for the player after they have hailed the spawn.

== Notes ==
If left out ''param4'' defaults to 10.

If left out ''param5'' defaults to the same value as ''param3''

''param5'' needs to be in the Commands table in the DB.

@@ Line 34: / Line 34: @@
 --SendUpdateDefaultCommand(NPC,10000,"hail") -- returns the bubble option when you hover over the spawn/npc
---AddPrimaryEntityCommand(Spawn,NPC,"hail2",10000,"hail2","",0,0,1) -- 1 at the end sets this as a default DENY list, if Spawn is supplied and not null/not player then that player gets default allow access.  Any other players must be added (either by calling the AddPrimaryEntityCommand or subsequently SetAccessToEntityCommand)
+--AddPrimaryEntityCommand(Spawn,NPC,"hail2",10000,"hail2","",0,0,1) -- 1 at the end sets this as a default DENY list.
 --SetAccessToEntityCommand(Spawn,NPC,"hail2",0) -- removes access to the just created hail2 for that player

@@ Line 27: / Line 27: @@
 |Notes = OptionalParam2 needs to be in the Commands table in the DB
 --AddPrimaryEntityCommand(Spawn,NPC,"",0,"") -- removes all the primary entity commands (including hail)
@@ Line 40: / Line 41: @@
 --RemovePrimaryEntityCommand(NPC,"hail2") -- removes hail2 command for all players
 }}

@@ Line 26: / Line 26: @@
 |ExampleDesc = Add the poke command to the spawn for the player after they have hailed the spawn.
 |Notes = OptionalParam2 needs to be in the Commands table in the DB
 }}

@@ Line 1: / Line 1: @@
-= LUA Functions: AddPrimaryEntityCommand() =
+{{LUAFunction
-Returns the current '''current hit points''' of ''param''. The parameter can be either a player or the NPC currently being interacted with.
+|Name = AddQuestPrereqItem
+|Description =  Adds an item prerequisite to the given quest.
+|Param1 = Spawn
-==== Syntax ====
+|Param1Desc = is the player who will see this new command on the given spawn, must be a player
-AddPrimaryEntityCommand(param1, param2, param3, [param4], [param5], [param6], [param7], [param8])
+|Param2 = Spawn
+|Param2Desc = is the spawn that will get the new command
-==== Parameters ====
+|Param3= string
-; Required - ''param1'' (spawn), ''param2'' (spawn), ''param3'' (string)
+|Param3Desc = is the name of the command
-: ''param1'' is the player who will see this new command on the given spawn, must be a player
+|OptionalParam1 = float
-: ''param2'' is the spawn that will get the new command
+|OptionalParam1Desc = is the max distance from the spawn to be able to use the command, defaults to 10 if left out
-: ''param3'' is the name of the command
+|OptionalParam2 = string
+|OptionalParam2Desc = is the command, defaults to the same value as param3 if left out
-; Optional -  ''param4'' (float), ''param5'' (string), ''param6'' (string), ''param7''(int16), ''param8'' (int32)
+|OptionalParam3 = string
-: ''param4'' is the max distance from the spawn to be able to use the command
+|OptionalParam3Desc = is the error text for when the command fails
-: ''param5'' is the command
+|OptionalParam4 = int16
-: ''param6'' is the error text for when the command fails
+|OptionalParam4Desc = is the time it takes to cast the command
-: ''param7'' is the time it takes to cast the command
+|OptionalParam5 = int32
-: ''param8'' is the spell visual for this command
+|OptionalParam5Desc = is the spell visual for this command
+|Example =
 <pre>
 function hailed(NPC, Spawn)
@@ Line 26: / Line 24: @@
 end
 </pre>
+|ExampleDesc = Add the poke command to the spawn for the player after they have hailed the spawn.
-Add the poke command to the spawn for the player after they have hailed the spawn.
+|Notes = OptionalParam2 needs to be in the Commands table in the DB
+}}