PropertyAdd

Description

Structure used for properties.Add.

Parameters

string Type

Can be set to "toggle" to make this property a toggle property.

Default: "simple"

string MenuLabel

Label to show on opened menu

string MenuIcon

Icon to show on opened menu for this item. Optional for simple properties and unused for toggle properties.

number StructureField (Order)

Where in the list should the property be positioned, relative to other properties.

For reference, here are the default properties and their Order values:

Property	Order
Bone Manipulate	500
Bodygroups	600
Skin	601
Keep Upright	900
Ignite/Extinguish	999
Remove	1000
Gravity	1001
Drive	1100
Collision	1500
Statue	1501
NPC Biggify/Smallify	1799, 1800
Motion Control (Kinect)	2500
Edit Properties	90001

boolean PrependSpacer

Whether to add a spacer before this property. This should generally be true for the first property in a group of properties.

Default: false

function Filter

Used clientside to decide whether this property should be shown for an entity. Gets these arguments:

table self - the property table
Entity ent - the entity the player clicked
LocalPlayer player - the localplayer

Return true if the property should be shown for this entity. It's good practice to call SANDBOX:CanProperty in this hook via gamemode.Call or hook.Run.

function Checked

Required for toggle properties (clientside). Must return a boolean value to either check or uncheck the toggle property.

table self - the property table
Entity ent - the entity the player clicked
table tr - the player's eye trace

function Action

Called clientside when the property is clicked with these arguments:

table self - the property table
Entity ent - the entity the player clicked
table tr - the player's eye trace

When appropriate, within this function you can call self:MsgStart(), write data with the net 'Write' functions, and finish with self:MsgEnd(). This will activate the 'Receive' function on the server. In most cases, you will want to send the entity to the server, as it's not done by default.

function Receive

Called serverside if the client sends a message in the 'Action' function (see above).

table self - the property table
number len - the net message length, although this includes the property identifier used internally (the name of the property)
Player ply - the player who clicked the property

You can read data received from the client with the net 'Read' functions. It's good practice to check SANDBOX:CanProperty here via gamemode.Call or hook.Run.

function MenuOpen

Called clientside when the property option has been created in the right-click menu. This is not called for toggle properties!

table self - the property table
DMenuOption option - the menu option
Entity ent - the entity the player right-clicked
table tr - the player's eye trace

function OnCreate

Same as MenuOpen, but also called for toggle properties and has different arguments. This is called immediately after MenuOpen, but nothing happens in between so you should only ever use one or the other.