Flutter Lua Plugin #
Embeds a Lua 5.2 interpreter into your Flutter app.
Executes Lua code on a background thread (not on the main UI thread).
Supports executing source code snippets from strings as well as from source files bundled in your app's asset bundle.
Android and iOS both.
Checking the Lua runtime version #
import 'package:flutter_lua/flutter_lua.dart' show Lua; print(await Lua.version);
Spawning a new Lua interpreter thread #
import 'package:flutter_lua/flutter_lua.dart' show LuaThread; var thread = await LuaThread.spawn();
Evaluating a Lua code snippet #
import 'package:flutter_lua/flutter_lua.dart' show LuaThread; var thread = await LuaThread.spawn(); await thread.eval("return 6 * 7"); //=> 42.0
Executing a bundled Lua source file #
import 'package:flutter_lua/flutter_lua.dart' show LuaThread; var thread = await LuaThread.spawn(); await thread.execAsset("scripts/myscript.lua");
Frequently Asked Questions #
How much does using this plugin increase my final app size? #
About 3.8 MiB, at present.
- Currently the only supported result datatypes from
LuaThread#eval*()methods are booleans, floating-point numbers (doubles), and strings. This will be extended further over the next releases.
All notable changes to this project will be documented in this file.
0.3.1 - 2019-04-24
- Improved the example app
0.3.0 - 2019-03-14
- Added initial iOS platform support (#1)
0.2.0 - 2019-03-10
0.1.0 - 2019-02-27
Demonstrates how to use the flutter_lua plugin.
Getting Started #
This project is a starting point for a Flutter application.
A few resources to get you started if this is your first Flutter project:
For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.
Use this package as a library
1. Depend on it
Add this to your package's pubspec.yaml file:
dependencies: flutter_lua: ^0.3.1
2. Install it
You can install packages from the command line:
$ flutter pub get
Alternatively, your editor might support
flutter pub get.
Check the docs for your editor to learn more.
3. Import it
Now in your Dart code, you can use:
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
We analyzed this package on Oct 16, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
- Dart: 2.5.1
- pana: 0.12.21
- Flutter: 1.9.1+hotfix.4
Detected platforms: Flutter
References Flutter, and has no conflicting libraries.