LuaBasicAPI abstract

abstractclassLuaBasicAPI

Implementers

• LuaState

Constructors

LuaBasicAPI()

LuaBasicAPI()

Properties

hashCode no setter inherited

intgethashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

Implementation

external int get hashCode;

runtimeType no setter inherited

TypegetruntimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation

external Type get runtimeType;

Methods

absIndex()

intabsIndex(intidx)

Implementation

int absIndex(int idx);

arith()

voidarith(ArithOpop)

Implementation

void arith(ArithOp op);

call()

voidcall(intnArgs,intnResults)

Implementation

void call(int nArgs, int nResults);

callAsync()

Future<void>callAsync(intnArgs,intnResults)

Asynchronously call a function. Use this when the function being called might be an async Dart function.

Implementation

Future<void> callAsync(int nArgs, int nResults);

checkStack()

boolcheckStack(intn)

Implementation

bool checkStack(int n);

compare()

boolcompare(intidx1,intidx2,CmpOpop)

Implementation

bool compare(int idx1, int idx2, CmpOp op);

concat()

voidconcat(intn)

Implementation

void concat(int n);

copy()

voidcopy(intfromIdx,inttoIdx)

Implementation

void copy(int fromIdx, int toIdx);

createTable()

voidcreateTable(intnArr,intnRec)

Implementation

void createTable(int nArr, int nRec);

error()

interror()

Implementation

int error();

getField()

LuaTypegetField(intidx,String?k)

Implementation

LuaType getField(int idx, String? k);

getGlobal()

LuaTypegetGlobal(Stringname)

Implementation

LuaType getGlobal(String name);

getI()

LuaTypegetI(intidx,inti)

Implementation

LuaType getI(int idx, int i);

getMetatable()

boolgetMetatable(intidx)

Implementation

bool getMetatable(int idx);

getTable()

LuaTypegetTable(intidx)

Implementation

LuaType getTable(int idx);

getTop()

intgetTop()

Implementation

int getTop();

insert()

voidinsert(intidx)

Implementation

void insert(int idx);

isBoolean()

boolisBoolean(intidx)

Implementation

bool isBoolean(int idx);

isDartFunction()

boolisDartFunction(intidx)

Implementation

bool isDartFunction(int idx);

isFunction()

boolisFunction(intidx)

Implementation

bool isFunction(int idx);

isInteger()

boolisInteger(intidx)

Implementation

bool isInteger(int idx);

isNil()

boolisNil(intidx)

Implementation

bool isNil(int idx);

isNone()

boolisNone(intidx)

Implementation

bool isNone(int idx);

isNoneOrNil()

boolisNoneOrNil(intidx)

Implementation

bool isNoneOrNil(int idx);

isNumber()

boolisNumber(intidx)

Implementation

bool isNumber(int idx);

isString()

boolisString(intidx)

Implementation

bool isString(int idx);

isTable()

boolisTable(intidx)

Implementation

bool isTable(int idx);

isThread()

boolisThread(intidx)

Implementation

bool isThread(int idx);

isUserdata()

boolisUserdata(intidx)

Implementation

bool isUserdata(int idx);

len()

voidlen(intidx)

Implementation

void len(int idx);

load()

ThreadStatusload(Uint8Listchunk,StringchunkName,String?mode)

Implementation

ThreadStatus load(Uint8List chunk, String chunkName, String? mode);

newTable()

voidnewTable()

Implementation

void newTable();

newUserdata()

Userdata<dynamic>newUserdata<T>()

Implementation

Userdata newUserdata<T>();

next()

boolnext(intidx)

Implementation

bool next(int idx);

noSuchMethod() inherited

dynamicnoSuchMethod(Invocationinvocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

pCall()

ThreadStatuspCall(intnArgs,intnResults,intmsgh)

Implementation

ThreadStatus pCall(int nArgs, int nResults, int msgh);

pCallAsync()

Future<ThreadStatus>pCallAsync(intnArgs,intnResults,intmsgh)

Asynchronously call a function in protected mode. Use this when the function being called might be an async Dart function.

Implementation

Future<ThreadStatus> pCallAsync(int nArgs, int nResults, int msgh);

pop()

voidpop(intn)

Implementation

void pop(int n);

pushBoolean()

voidpushBoolean(boolb)

Implementation

void pushBoolean(bool b);

pushDartClosure()

voidpushDartClosure(intFunction(LuaStatels)f,intn)

Implementation

void pushDartClosure(DartFunction f, int n);

pushDartClosureAsync()

voidpushDartClosureAsync(Future<int>Function(LuaStatels)f,intn, [String?name,]);

Push an async Dart closure onto the stack with upvalues. name is an optional human-readable name used to format the "attempt to call async function name without await or in non-async context" runtime error message.

Implementation

void pushDartClosureAsync(DartFunctionAsync f, int n, [String? name]);

pushDartFunction()

voidpushDartFunction(intFunction(LuaStatels)f)

Implementation

void pushDartFunction(DartFunction f);

pushDartFunctionAsync()

voidpushDartFunctionAsync(Future<int>Function(LuaStatels)f, [String?name,]);

Push an async Dart function onto the stack. name is an optional human-readable name used to format the "attempt to call async function name without await or in non-async context" runtime error message.

Implementation

void pushDartFunctionAsync(DartFunctionAsync f, [String? name]);

pushFString()

voidpushFString(Stringfmt, [List<Object>?a])

Implementation

void pushFString(String fmt, [List<Object>? a]);

pushGlobalTable()

voidpushGlobalTable()

Implementation

void pushGlobalTable();

pushInteger()

voidpushInteger(int?n)

Implementation

void pushInteger(int? n);

pushNil()

voidpushNil()

Implementation

void pushNil();

pushNumber()

voidpushNumber(doublen)

Implementation

void pushNumber(double n);

pushString()

voidpushString(String?s)

Implementation

void pushString(String? s);

pushValue()

voidpushValue(intidx)

Implementation

void pushValue(int idx);

rawEqual()

boolrawEqual(intidx1,intidx2)

Implementation

bool rawEqual(int idx1, int idx2);

rawGet()

LuaTyperawGet(intidx)

Implementation

LuaType rawGet(int idx);

rawGetI()

LuaTyperawGetI(intidx,inti)

Implementation

LuaType rawGetI(int idx, int i);

rawLen()

intrawLen(intidx)

Implementation

int rawLen(int idx);

rawSet()

voidrawSet(intidx)

Implementation

void rawSet(int idx);

rawSetI()

voidrawSetI(intidx,inti)

Implementation

void rawSetI(int idx, int i);

register()

voidregister(Stringname,intFunction(LuaStatels)f)

Implementation

void register(String name, DartFunction f);

remove()

voidremove(intidx)

Implementation

void remove(int idx);

replace()

voidreplace(intidx)

Implementation

void replace(int idx);

rotate()

voidrotate(intidx,intn)

Implementation

void rotate(int idx, int n);

setField()

voidsetField(intidx,String?k)

Implementation

void setField(int idx, String? k);

setGlobal()

voidsetGlobal(Stringname)

Implementation

void setGlobal(String name);

setI()

voidsetI(intidx,int?i)

Implementation

void setI(int idx, int? i);

setMetatable()

voidsetMetatable(intidx)

Implementation

void setMetatable(int idx);

setTable()

voidsetTable(intidx)

Implementation

void setTable(int idx);

setTop()

voidsetTop(intidx)

Implementation

void setTop(int idx);

stringToNumber()

boolstringToNumber(Strings)

Implementation

bool stringToNumber(String s);

toBoolean()

booltoBoolean(intidx)

Implementation

bool toBoolean(int idx);

toDartFunction()

intFunction(LuaStatels)?toDartFunction(intidx)

Implementation

DartFunction? toDartFunction(int idx);

toInteger()

inttoInteger(intidx)

Implementation

int toInteger(int idx);

toIntegerX()

int?toIntegerX(intidx)

Implementation

int? toIntegerX(int idx);

toNumber()

doubletoNumber(intidx)

Implementation

double toNumber(int idx);

toNumberX()

double?toNumberX(intidx)

Implementation

double? toNumberX(int idx);

toPointer()

Object?toPointer(intidx)

Implementation

Object? toPointer(int idx);

toStr()

String?toStr(intidx)

Implementation

String? toStr(int idx);

toString() inherited

StringtoString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

Implementation

external String toString();

toUserdata()

Userdata<dynamic>?toUserdata<T>(intidx)

Implementation

Userdata? toUserdata<T>(int idx);

type()

LuaTypetype(intidx)

Implementation

LuaType type(int idx);

typeName()

StringtypeName(LuaTypetp)

Implementation

String typeName(LuaType tp);

Operators

operator ==() inherited

booloperator ==(Objectother)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

Implementation

external bool operator ==(Object other);