Bungee Logic : Schema : Argument
Contents |
[edit] Description
Declares a new argument in the current function.
[edit] Syntax
access [IN] type name access [OUT] type name
Where:
access
Is one of: public, protected, private, or internal. Currently, changing the access modifier has no effect.
type Is the type you declare the argument to be; for example, a string or an int. name Is an argument name unique to the function. The typical naming convention in Bungee is to use camel case, for example: myArg. [IN]
[OUT]
Specifies the (in/out) direction the argument data will be copied to. Direction [in]: specifies the parameter is an input value to be read within the function.
Direction [out]: specifies the parameter is an output value. This value is used to set any return values from the function.Important Just as when calling operations using the SOAP protocol, functions in Bungee Logic have no explicit return value. Output or return values are set using [out] parameters exclusively. Out parameters cannot be used to read any values within the function; there is currently not an [in/out] parameter in Bungee Logic.
[edit] Logic
[+] public MyFunction([in] string arg1, [out] int arg2)
[edit] Error Handling
-None-
[edit] Intrinsics
-None-
[edit] Properties
General Tab
- Access Modifier — Specifies the field's visibility.
- Adapter List — Specify a list of form and/or function adapters.
- Default Value — A site that determines the value that the field is initialized with. For priimitive types like string, boolean, and int, the site should usually be a Data. For objects, the site should usually be an Object so that an actual runtime object gets created for the field (unless the field is meant to be a reference to another object).
- Enumeration — For setting value/display pairs for when the field is bound to something like a combo box.
- Is Collection — If selected, creates a the field as a collection of the type you declared the field to be.
- Is Map — Toggles the class member field as a Map containing key-value pairs.
- Direction — Specifies the direction of data flow to or from the function.
- Name — The name of the field. This must be unique to the class.
- Nullable — Set the field to null when the class is constructed, or to allow a null argument to be passed to a function.
- Type — The type of the field. To change the type of the field from the default of string, select the field statement, and select the ellipsis button for the Type property on the Property Editor. The type selection dialog will appear that will allow you to select from the available types for the current project. To access the default types available in the Runtime, select the project->Dependencies->Runtime->Types project in the type selection tree.
Behavior Tab
- Always Sent — Send the field data to the sever even when the field value is null.
- Copy Type — Specify ownership and how copy operations will apply to this field.
- Defer List —
- Is Encrypted —
- Manage Reference Count — Turn on/off automatic reference counting (and garbage collection).
- Needs Encoding — Indicates that the field needs to be HTML encoded.
- Property CategoryAdapter — Select which tab the field (presented as a property) will appear in within a property pane.
- Property FormAdapter — Specify a custom data entry form for use in a property pane.
- Property Label — Specify the text that appears in a property pane associated with this field.
- Sort Ascending — Determine the order of a sort on a Collection.
- Sort Connection Adapter — Choose the connection adapter for sorting a Collection of objects. After you choose the connection adapter, use the Sort Ascending property to determine the sort order.
- State — Dynamically hide, show, enable, and disable controls bound to this field at runtime.
- Track for Cancel — Restore the initial value of the field if notified that the parent dialog is canceled.
[edit] See Also
Runtime Type : Meta : Argument