User Tools

Site Tools


en:code:template

This is a template for code objects.

ObjectName

Object description.

Functions

functionName

Function description.

Syntax

ObjectName.functionName(argument1, argument2);

Arguments

  1. argument1 - (type) argument description
  2. argument2 - (type) argument description

Returns

  • (type) return description

Exceptions

  • (exceptionType) exception description

Example

ObjectName.functionName(125, "data"); //Optional description

See also

  • link

Notes

Notes.

Methods

methodName

Method description.

Syntax

myObject.methodName(argument1, argument2);

Arguments

  1. argument1 - (type) argument description
  2. argument2 - (type) argument description

Returns

  • (type) return description

Exceptions

  • (exceptionType) exception description

Example

myObject.methodName(125, "data"); //Optional description

See also

  • link

Notes

Notes.

Enumerations

enumerationName

Enumeration description.

Values

  1. value1: value description
  2. value2: value description
  3. value3: value description

Example

ObjectName.functionName(ObjectName.enumerationValue); //Optional description

See also

  • link

Notes

Notes.

Variables

variableName

Variable description.

Example

ObjectName.variableName = 42; //Optional description
Script.print(ObjectName.variableName); //Optional description

See also

  • link

Notes

Notes.

Events

eventName

Event description.

Syntax

myObject.eventName = function(argument1, argument2) {};

Arguments

  1. argument1 - (type) argument description
  2. argument2 - (type) argument description

Example

myObject.eventName = function(argument1, argument2) {
//Event action
}; //Optional description

See also

  • link

Notes

Notes.

Attributes

attributeName

Attribute description.

Example

myObject.attributeName = 42; //Optional description
Script.print(myObject.attributeName); //Optional description

See also

  • link

Notes

Notes.

en/code/template.txt · Last modified: 2021/02/13 11:23 by 127.0.0.1