Help Statement

Help

You can use the helpmeor ? command to get information about an object. It will give you information about types, objects and methods.

helpme terminates the execution of a program and returns data about the specified object. If no object is specified, helpme returns information about the context. The statement gives you a list of the things that can be done with the object.

Helpme DataType

When used with a datatype, it returns infomation about all of the static methods, fields and properties associated with that type.

helpme Vector3;

// *Returns* 
// ----------------------------
// static Single Distance(Vector3 a, Vector3 b)
// static Vector3 Distance(Vector3 a, Vector3 b, Single interp)
// ...
// ...

---

Helpme Object

When used with an instance of an object, it returns a list of all of the instance methods, fields and properties of that class.

Vector3 vec;
helpme vec;

// *Returns* 
// ----------------------------
// Single x
// Single x
// Single magnitude { get; }
// Vector3 normalized { get; }
// Vector3 GetNormalized()
// ...
// ...

---

Helpme Method

When used on a method, it will return the method signature

helpme Vector3.Dot;  // not a function call, no ()

// *Returns* 
// ----------------------------
// Single Dot(Vector3 a, Vector3 b)

? is an alternative for helpme

? Vector3; // same as helpme Vector3