GH_ComponentGH_InputParamManagerAddPointParameter Method (String, String, String, GH_ParamAccess, Point3d) |
Register a new 3D point param with a single default coordinate.
Namespace:
Grasshopper.Kernel
Assembly:
Grasshopper (in Grasshopper.dll)
Syntax public int AddPointParameter(
string name,
string nickname,
string description,
GH_ParamAccess access,
Point3d default
)
Public Function AddPointParameter (
name As String,
nickname As String,
description As String,
access As GH_ParamAccess,
default As Point3d
) As Integer
Parameters
- name
- Type: SystemString
The name of the parameter. Keep it short, single words are best. - nickname
- Type: SystemString
The nickname of the parameter. Keep it short, single characters are best. - description
- Type: SystemString
The description of the parameter. Be succinct but clear, single sentences are best. - access
- Type: Grasshopper.KernelGH_ParamAccess
Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively. - default
- Type: Point3d
A default value to store in the parameter Persistent Data.
Return Value
Type:
Int32See Also