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

A
	A Discussion On fori
otlib.	access
	Access
	Access Registration
	AccessDenied, otlib.InvalidCondition
	AddCommand, otlib.Plugin
	AddHook, otlib.Plugin
	AddKey, otlib.DataTable
	AddListOfKeyValues, otlib.DataTable
	Append, otlib
	Autocomplete otlib.BaseParam otlib.NumParam
B
otlib.	BaseParam
	BaseParam Variables, otlib.BaseParam
	BeginTransaction otlib.DataTable wrappers
C
	CheckAccess, otlib.group
	CheckArg, otlib
	ClearCache, otlib.DataTable
	Clone otlib otlib.object
	Code Conventions
	Command Wrappers, wrappers
	ConvertTo, otlib.DataTable
	Copy, otlib
	CopyI, otlib
	Count, otlib
	CreateDataTable, otlib
	CreatePlugin, otlib
D
	DatabaseTypes, otlib
	DataEqualsAnyOf, otlib
otlib.	DataTable
	Debugging Tools
	DeepCopy, otlib
	default, otlib.BaseParam
	Default, otlib.BaseParam
	Defines
	Denied Levels, otlib.InvalidCondition
	DifferenceByKey, otlib
	DifferenceByKeyI, otlib
	DifferenceByValue, otlib
	DisableCache, otlib.DataTable
	Do Tests
E
	EditDistance, otlib
	Empty otlib otlib.DataTable
	EnableCache, otlib.DataTable
	EndTransaction otlib.DataTable wrappers
	Escape, otlib
	Execute, wrappers
	Explode, otlib
F
	Fetch, otlib.DataTable
	File Wrapper Functions, wrappers
	FileDelete, wrappers
	FileExists, wrappers
	FileRead, wrappers
	FileWrite, wrappers
	Flatfile, otlib
	FormatAndEscapeData, wrappers
	FromString otlib.BaseParam otlib.NumParam
G
	GetAll, otlib.DataTable
	GetDefault, otlib.BaseParam
	GetGroup
	GetLevel, otlib.InvalidCondition
	GetMaxRepeats, otlib.BaseParam
	GetMessage, otlib.InvalidCondition
	GetMinRepeats, otlib.BaseParam
	GetParameterNum, otlib.InvalidCondition
	GetPlugins, otlib
	GetTakesRestOfLine, otlib.BaseParam
	GNU General Public License
otlib.	group
	Group Access
H
	HasValue, otlib
	HasValueI, otlib
	How to Apply These Terms to Your New Programs

Each registered access represents a single permission.

Given when the user has no permission to the access at all.

function Plugin:AddCommand( console_command,
say_command,
callback,
access )

Adds a command on behalf of this plugin.

function Plugin:AddHook( hook,
callback,
priority )

Adds a hook on behalf of this plugin.

function DataTable:AddKey( key_name,
key_type,
comment )

Adds a key to the data table.

function DataTable:AddListOfKeyValues( list_name,
key_type,
value_type,
comment )

Adds a key to the data table, whose value is going to be a table.

function Append( list_a,
list_b,
in_place )

Appends values with numeric keys from one table to another.

function BaseParam:Autocomplete( user,
str )

Used to give autocomplete information for this parameter.

function NumParam:Autocomplete( user,
cmd,
arg )

See otlib.BaseParam.Autocomplete.

The base parameter in the parameter system.

These variables help provide BaseParam’s meager feature set.

function DataTable:BeginTransaction()

Begins a transaction.

function BeginTransaction( database_type )

If the SQL implementation allows it, start a transaction.

function group:CheckAccess( access,
... )

Checks if a user or group can use an access with specified, possibly parsed arguments.

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

Used to check to see if a function argument matches what is expected.

function DataTable:ClearCache()

Clears any cache that may be built up in this datatable.

function Clone( base,
callable,
clone )

Creates a clone of an object.

Exactly the same as otlib.Clone.

function DataTable:ConvertTo( database_type )

Convert the DataTable from using one database type to another.

function Copy( t )

Make a shallow copy of a table.

function CopyI( t )

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

function Count( t )

Counts the number of elements in a table using pairs.

function CreateDataTable( table_name,
primary_key_name,
primary_key_type,
comment,
database_type )

Creates a new data table for use.

function CreatePlugin( name,
description,
author )

Creates a plugin by name.

DatabaseTypes

function DataEqualsAnyOf( data,
... )

Checks to see if an argument equals any of the other arguments passed in.

function DeepCopy( t )

Make a deep copy of a table.

A variable of any type specifying the value to use if the parameter is optional (min repeats is 0) and left unspecified.

function BaseParam:Default( default )

Set the default value of this parameter.

Blah.

This is used in InvalidCondition, a return from otlib.group.CheckAccess to specify what part of the access level an access check failed on.

function DifferenceByKey( table_a,
table_b,
in_place )

Gets the difference of two tables by key.

function DifferenceByKeyI( table_a,
table_b,
in_place )

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

function DifferenceByValue( list_a,
list_b,
in_place )

Gets the difference of two lists by value.

function DataTable:DisableCache()

First clears the cache with ClearCache and disables further caching until re-enabled with EnableCache.

Run this file to run the OTLib test suite.

function EditDistance( s,
t,
lim )

Finds the edit distance between two strings or tables.

function Empty( t )

Removes all data from a table.

function DataTable:Empty()

Empties all existing data for this database and clears any caches.

function DataTable:EnableCache()

See DisableCache.

function DataTable:EndTransaction()

See BeginTransaction.

function EndTransaction( database_type )

If the SQL implementation allows it, end a transaction.

function Escape( str )

Makes a string safe for pattern usage, like in string.gsub().

function Execute( database_type,
statement,
key_types )

Execute given statement on the database.

function Explode( str,
separator,
plain,
limit )

Split a string by a string.

function DataTable:Fetch( primary_key )

Fetch a row from the database.

function FileDelete( file_path )

Delete a file or folder.

function FileExists( file_path )

Check to see if a file or folder exists.

function FileRead( file_path )

Read a file.

function FileWrite( file_path,
data )

Write to a file.

A plain text, readable text file.

function FormatAndEscapeData( data )

Formats and escapes data from lua to be appropriate for use in SQL.

function BaseParam:FromString( str )

Loads in user permissions from a string produced by ToString for this parameter.

function NumParam:FromString( str )

See otlib.BaseParam.FromString and ToString.

function DataTable:GetAll()

Fetchs all rows from the database.

function BaseParam:GetDefault()

Gets the default for this parameter.

function GetGroup( group )

function InvalidCondition:GetLevel()

Gets the level for the invalid condition, see Denied Levels.

function BaseParam:GetMaxRepeats()

Gets the max repeats for this parameter.

function InvalidCondition:GetMessage()

Gets the message for the invalid condition, if one has been created yet.

function BaseParam:GetMinRepeats()

Gets the min repeats for this parameter.

function InvalidCondition:GetParameterNum()

Gets the parameter number the invalid condition occured on, if applicable.

function GetPlugins()

A table of the plugins, indexed by plugin name.

function BaseParam:GetTakesRestOfLine()

Gets whether or not this parameter takes the rest of the line.

Version 3, 29 June 2007

function HasValue( t,
value )

Checks for the presence of a value in a table.

function HasValueI( t,
value )

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

If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.