Index - OTLib

Index

$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z

I
	Init otlib.InvalidCondition otlib.Plugin
	Initialization
	InitPlugins, otlib
	Insert, otlib.DataTable
	IntersectionByKey, otlib
	IntersectionByKeyI, otlib
	IntersectionByValue, otlib
	Invalid, otlib.InvalidCondition
otlib.	InvalidCondition
	InvalidConditions, otlib.InvalidCondition
	IsA otlib otlib.object
	IsEmpty, otlib
	IsValid otlib.BaseParam otlib.NumParam
L
	License
	LongUsage, otlib.BaseParam
	LTrim, otlib
M
	MakeKeyValues, otlib
	Max, otlib.NumParam
	max_repeats, otlib.BaseParam
	MaxRepeats, otlib.BaseParam
	Min, otlib.NumParam
	min_repeats, otlib.BaseParam
	MinRepeats, otlib.BaseParam
	MySQL, otlib
N
	NoAccess, otlib.InvalidCondition.DeniedLevel
	NotSpecified, otlib.InvalidCondition
	Numeric Utilities, otlib
otlib.	NumParam
O
otlib.	object
	Other Utilities, otlib
	otlib access.lua debug.lua defines.lua init.lua parameters.lua plugins.lua prototype.lua simpledata.lua table_utils.lua utils.lua
	OTLib Readme
P
	Parameters Global otlib.InvalidCondition.DeniedLevel
	Parent otlib otlib.object
	Parse otlib.BaseParam otlib.NumParam
	ParseArgs, otlib
	ParseKeyValues, otlib
otlib.	Plugin
	Plugins
	Preamble
	preferred_database_type, otlib
	Prototype Inheritance
R
	Register, otlib.access
	Remove, otlib.DataTable
	RemoveDuplicateValues, otlib
	Round, otlib
	RoundTo, otlib.NumParam
	RTrim, otlib
S
	SetFromList, otlib
	SetLevel, otlib.InvalidCondition
	SetParameterNum, otlib.InvalidCondition
	SetVersion, otlib.Plugin
	ShortUsage, otlib.BaseParam
	Simple Data
	SplitCommentHeader, otlib
	SQL Wrapper Functions, wrappers
	SQLite, otlib
	Start, otlib.Plugin
	Stop, otlib.Plugin
	StoredExpression, otlib
	String Utilities, otlib
	StripComments, otlib
T
	Table Conversion Untilities, otlib
	Table Utilities
	TakesRestOfLine, otlib.BaseParam
	Terms and Conditions
	ThrowBadArg, otlib
	ToBool, otlib
	TooHigh, otlib.InvalidCondition
	TooLow, otlib.InvalidCondition
	ToString otlib.BaseParam otlib.NumParam
	Trim, otlib
U
	UnionByKey, otlib
	UnionByKeyI, otlib
	UnionByValue, otlib
	UntrackedCopy, otlib.DataTable
	User Access, otlib.group
	UserParameters, otlib.InvalidCondition.DeniedLevel
	Utilities

function InvalidCondition:Init( ... )

Called when a new InvalidCondition object is created by using the prototype as a functor.

function Plugin:Init()

Override this function if you want to run some functionality when the plugin initializes.

Initialization of OTLib occurs here

function InitPlugins()

Intended to be called only once by the application-specific implementation after running all plugin files.

function DataTable:Insert( primary_key,
data )

Insert (or replace existing with) a new row.

function IntersectionByKey( table_a,
table_b,
in_place )

Gets the intersection of two tables by key.

function IntersectionByKeyI( table_a,
table_b,
in_place )

Exactly the same as IntersectionByKey except that it uses fori instead of pairs.

function IntersectionByValue( list_a,
list_b,
in_place )

Gets the intersection of two lists by value.

Given when the specified value is not a number.

function IsA( clone,
base )

Check if a clone is inherited from another.

Exactly the same as otlib.IsA.

function IsEmpty( t )

Checks if a table contains any values on any type of key.

function BaseParam:IsValid( user,
arg )

Checks if the given argument is valid within the context of what’s allowable.

function NumParam:IsValid( user,
arg )

See otlib.BaseParam.IsValid.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

function BaseParam:LongUsage( user )

Used to give information about the usage on this parameter when screen space is not an issue.

function LTrim( str )

Exactly like Trim except it only trims the left side.

function MakeKeyValues( t )

Makes a key values string from a table.

function NumParam:Max( max )

Sets the maximum number for this argument.

The maximum number of times this parameter is allowed to repeat.

function BaseParam:MaxRepeats( max_repeats )

Set the maximum number of times this argument is allowed to repeat.

function NumParam:Min( min )

Sets the minimum number for this argument.

The minimum number of times this parameter must repeat.

function BaseParam:MinRepeats( min_repeats )

Set the minimum number of times this argument must repeat.

MySQL.

The user has no access to this command at all.

Given when there is no specified value and the argument is not optional.

The number parameter.

Merely serves as a convenient wrapper and root prototype.

Things that don’t fit in any other category.

Version 1.0

The specified arguments did not meet the requirements for the access being used.

function Parent( clone )

Gets the parent of a clone.

Exactly the same as otlib.Parent.

function BaseParam:Parse( user,
arg )

Parses a string into the appropriate type for this parameter.

function NumParam:Parse( user,
arg )

See otlib.BaseParam.Parse.

function ParseArgs( args )

This is similar to Explode with ( str, “%s+” ) except that it will not split up words within quotation marks.

function ParseKeyValues( str )

Parses a key value formatted string into a table.

The GNU General Public License is a free, copyleft license for software and other kinds of works.

preferred_database_type

The DatabaseTypes to use by default.

See http://en.wikipedia.org/wiki/Prototype_based_programming for detailed information about prototype inheritance.

function access:Register( tag,
... )

Registers a new access object.

function DataTable:Remove( primary_key )

Delets a row from the database.

function RemoveDuplicateValues( list,
in_place )

Removes any duplicate values from a list.

function Round( num,
places )

Rounds a number to a given decimal place.

function NumParam:RoundTo( round_to )

Sets what to round this argument too during Parse.

function RTrim( str )

Exactly like Trim except it only trims the right side.

function SetFromList( list )

Creates a set from a list.

function InvalidCondition:SetLevel( level )

Sets the level for this invalid condition, see Denied Levels.

function InvalidCondition:SetParameterNum( num )

Sets the parameter number the invalid condition occured on.

function Plugin:SetVersion( version,
version_suffix )

Set the version and version suffix of the plugin.

function BaseParam:ShortUsage( user )

Used to give information about the usage on this parameter as concisely as possible.

Offers a wrapper around file or database I/O for simple data needs.

function SplitCommentHeader( str,
comment_prefix )

Splits a comment header in a string.

SQLite.

function Plugin:Start()

Start the plugin.

function Plugin:Stop()

Stop the plugin.

function StoredExpression()

Creates an object that will store an expression.

function StripComments( str,
line_comment )

Strips comments from a string.

Convert tables between one thing and another!

Utility functions that deal specifically with tables.

function BaseParam:TakesRestOfLine( takes_rest_of_line )

Set the argument to take the rest of whatever arguments are available.

function ThrowBadArg( argnum,
fn_name,
expected,
data,
throw_level )

“Throws” an error similar to the lua standard error of “bad argument #x to fn_name (type expected, got type)”.

function ToBool( value )

Converts a boolean, nil, string, or number to a boolean value.

Given when the specified value is too high.

Given when the specified value is too low.

function BaseParam:ToString()

Converts any options on this parameter that would be used for user permissions to a string that can be read in again later using FromString.

function NumParam:ToString()

See otlib.BaseParam.ToString.

function Trim( str )

Trims leading and tailing whitespace from a string.

function UnionByKey( table_a,
table_b,
in_place )

Merges two tables by key.

function UnionByKeyI( table_a,
table_b,
in_place )

Exactly the same as UnionByKey except that it uses fori instead of pairs.

function UnionByValue( list_a,
list_b,
in_place )

Gets the union of two lists by value.

function DataTable:UntrackedCopy( data )

One of the downsides of using DataTable is that data you get out of it (except GetAll) can’t be thrown throw an iterator like pairs because of the way we track changes to the table.

The specified arguments met the hard requirements for the access being used, but not this particular user’s access to the command.

Table specific utilities are in the file Table Utilities.