GH_Component.GH_InputParamManager.AddBoxParameter Method (String, String, String, GH_ParamAccess, Box) |
Add a 3D Box parameter to the input list of this component.
Namespace:
Grasshopper.Kernel
Assembly:
Grasshopper (in Grasshopper.dll)
Syntax public int AddBoxParameter(
string name,
string nickname,
string description,
GH_ParamAccess access,
Box default
)
Public Function AddBoxParameter (
name As String,
nickname As String,
description As String,
access As GH_ParamAccess,
default As Box
) As Integer
Parameters
- name
- Type: System.String
The name of the parameter. Keep it short, single words are best. - nickname
- Type: System.String
The nickname of the parameter. Keep it short, single characters are best. - description
- Type: System.String
The description of the parameter. Be succinct but clear, single sentences are best. - access
- Type: Grasshopper.Kernel.GH_ParamAccess
Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. - default
- Type: Box
A default value to store in the parameter Persistent Data.
Return Value
Type:
Int32See Also