GetPickupPropertyValue

From Onset Developer Wiki
Revision as of 21:34, 22 December 2020 by BlueMountains (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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