Function Reference
From Sputnik Wiki
(Difference between revisions)
(→Console Functions) |
(→Function Reference) |
||
Line 5: | Line 5: | ||
==== Console Functions ==== | ==== Console Functions ==== | ||
− | * [[Core Function Print|Print( | + | * [[Core Function Print|Print( <expression> )]] -- Prints an expressions string value to the console window. |
− | * [[Core Function Println|Println( | + | * [[Core Function Println|Println( <expression> )]] -- Prints an expressions string value to the console window and inserts a newline charactor at the end. |
− | * [[Core Function Input|Input( | + | * [[Core Function Input|Input( <expression> )]] -- Capture a string typed to console window. |
− | * [[Core Function InputC|InputC( | + | * [[Core Function InputC|InputC( <expression> )]] -- Capture a char typed to console window. |
==== Variable Type Conversions ==== | ==== Variable Type Conversions ==== | ||
− | * [[Core Function Byte|Byte( | + | * [[Core Function Byte|Byte( <expression> )]] -- Returns the 8-bit integer (whole number) representation of an expression. |
− | * [[Core Function Int16|Int16( | + | * [[Core Function Int16|Int16( <expression> )]] -- Returns the 16-bit integer (whole number) representation of an expression. |
− | * [[Core Function Int32|Int32( | + | * [[Core Function Int32|Int32( <expression> )]] (Alias: Int( $variable )) -- Returns the 32-bit integer (whole number) representation of an expression. |
− | * [[Core Function Int64|Int64( | + | * [[Core Function Int64|Int64( <expression> )]] -- Returns the 64-bit integer (whole number) representation of an expression. |
− | * [[Core Function Float|Float( | + | * [[Core Function Float|Float( <expression> )]] -- Returns the 32-bit floating point representation of an expression. |
− | * [[Core Function Double|Double( | + | * [[Core Function Double|Double( <expression> )]] -- Returns the 64-bit floating point representation of an expression. |
− | * [[Core Function String|String( | + | * [[Core Function String|String( <expression> )]] -- Returns the String representation of an expression. |
==== Common Variable Functions ==== | ==== Common Variable Functions ==== | ||
Line 34: | Line 34: | ||
==== Misc Functions ==== | ==== Misc Functions ==== | ||
− | * [[Core Function Return|Return( | + | * [[Core Function Return|Return( <expression> )]] -- Returns a result from a Function. |
− | * [[Core Function Require|Require( | + | * [[Core Function Require|Require( <expression> )]] -- Includes a file in the current script. |
[[Category:Language Reference]] | [[Category:Language Reference]] |
Revision as of 03:41, 9 November 2011
Contents |
Function Reference
User Functions
Core Functions
Console Functions
- Print( <expression> ) -- Prints an expressions string value to the console window.
- Println( <expression> ) -- Prints an expressions string value to the console window and inserts a newline charactor at the end.
- Input( <expression> ) -- Capture a string typed to console window.
- InputC( <expression> ) -- Capture a char typed to console window.
Variable Type Conversions
- Byte( <expression> ) -- Returns the 8-bit integer (whole number) representation of an expression.
- Int16( <expression> ) -- Returns the 16-bit integer (whole number) representation of an expression.
- Int32( <expression> ) (Alias: Int( $variable )) -- Returns the 32-bit integer (whole number) representation of an expression.
- Int64( <expression> ) -- Returns the 64-bit integer (whole number) representation of an expression.
- Float( <expression> ) -- Returns the 32-bit floating point representation of an expression.
- Double( <expression> ) -- Returns the 64-bit floating point representation of an expression.
- String( <expression> ) -- Returns the String representation of an expression.
Common Variable Functions
- isInt( $variable ) -- Checks if a variable is an integer type
- isFloat( $variable ) -- Checks if a variable is a float-type
- isNumber( $variable ) -- Checks if a variable is a integer or float-type
- isString( $variable ) -- Checks if a variable is a string type
- isArray( $variable ) -- Check if a variable is an array
- isHash( $variable ) -- Check if a variable is an hash
- isObj( $variable ) -- Check if a variable is an object type
- isClass( $variable ) -- Check if a variable's object type is a class
- isStruct( $variable ) -- Check if a variable's object type is a struct
Misc Functions
- Return( <expression> ) -- Returns a result from a Function.
- Require( <expression> ) -- Includes a file in the current script.