GetPickupPropertyValue: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server & Client|1.0}} {{FuncDescription|Gets a property value for this entity.}} {{FuncSyntax|GetPickupPropertyValue(pickup, PropertyName)}} {{FuncParameter..."
 
No edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 12: Line 12:


== Example ==
== Example ==
__EDIT_ME__
=== Server ===
<syntaxhighlight lang="Lua">
function OnPackageStart()
local pickup = CreatePickup(1, 0.0, 0.0, 0.0)
SetPickupPropertyValue(pickup, "testValue", "Some test value string")
end
AddEvent("OnPackageStart", OnPackageStart)
</syntaxhighlight>
 
=== Client ===
<syntaxhighlight lang="Lua">
AddEvent("OnPickupStreamIn", function(pickup)
AddPlayerChat("P: "..GetPickupPropertyValue(pickup, "testValue"))
end)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{PickupFunctions}}

Latest revision as of 21:34, 22 December 2020

GetPickupPropertyValue

Type: Function
Context: Server & Client
Introduced: v1.0

Description

Gets a property value for this entity.

Syntax

GetPickupPropertyValue(pickup, PropertyName)

Parameters

  • pickup
    The pickup identifier
  • PropertyName
    Name of the property variable

Return Value

  • Returns the value.

Example

Server

function OnPackageStart()
	local pickup = CreatePickup(1, 0.0, 0.0, 0.0)
	SetPickupPropertyValue(pickup, "testValue", "Some test value string")
end
AddEvent("OnPackageStart", OnPackageStart)

Client

AddEvent("OnPickupStreamIn", function(pickup)
	AddPlayerChat("P: "..GetPickupPropertyValue(pickup, "testValue"))
end)

See also