120 lines
5.9 KiB
C#
120 lines
5.9 KiB
C#
using System;
|
|
|
|
using NLua;
|
|
|
|
// ReSharper disable UnusedMember.Global
|
|
namespace BizHawk.Client.Common
|
|
{
|
|
public sealed class MovieLuaLibrary : DelegatingLuaLibrary
|
|
{
|
|
public MovieLuaLibrary(Lua lua)
|
|
: base(lua) { }
|
|
|
|
public MovieLuaLibrary(Lua lua, Action<string> logOutputCallback)
|
|
: base(lua, logOutputCallback) { }
|
|
|
|
public override string Name => "movie";
|
|
|
|
[LuaMethodExample("if ( movie.startsfromsavestate( ) ) then\r\n\tconsole.log( \"Returns whether or not the movie is a savestate-anchored movie\" );\r\nend;")]
|
|
[LuaMethod("startsfromsavestate", "Returns whether or not the movie is a savestate-anchored movie")]
|
|
public bool StartsFromSavestate() => APIs.Movie.StartsFromSavestate();
|
|
|
|
[LuaMethodExample("if ( movie.startsfromsaveram( ) ) then\r\n\tconsole.log( \"Returns whether or not the movie is a saveram-anchored movie\" );\r\nend;")]
|
|
[LuaMethod("startsfromsaveram", "Returns whether or not the movie is a saveram-anchored movie")]
|
|
public bool StartsFromSaveram() => APIs.Movie.StartsFromSaveram();
|
|
|
|
[LuaMethodExample("local stmovfil = movie.filename( );")]
|
|
[LuaMethod("filename", "Returns the file name including path of the currently loaded movie")]
|
|
public string Filename() => APIs.Movie.Filename();
|
|
|
|
[LuaMethodExample("local nlmovget = movie.getinput( 500 );")]
|
|
[LuaMethod("getinput", "Returns a table of buttons pressed on a given frame of the loaded movie")]
|
|
public LuaTable GetInput(int frame, int? controller = null)
|
|
{
|
|
return APIs.Movie
|
|
.GetInput(frame, controller)
|
|
.ToLuaTable(Lua);
|
|
}
|
|
|
|
[LuaMethodExample("local stmovget = movie.getinputasmnemonic( 500 );")]
|
|
[LuaMethod("getinputasmnemonic", "Returns the input of a given frame of the loaded movie in a raw inputlog string")]
|
|
public string GetInputAsMnemonic(int frame) => APIs.Movie.GetInputAsMnemonic(frame);
|
|
|
|
[LuaMethodExample("if ( movie.getreadonly( ) ) then\r\n\tconsole.log( \"Returns true if the movie is in read-only mode, false if in read+write\" );\r\nend;")]
|
|
[LuaMethod("getreadonly", "Returns true if the movie is in read-only mode, false if in read+write")]
|
|
public bool GetReadOnly() => APIs.Movie.GetReadOnly();
|
|
|
|
[LuaMethodExample("local ulmovget = movie.getrerecordcount();")]
|
|
[LuaMethod("getrerecordcount", "Gets the rerecord count of the current movie.")]
|
|
public ulong GetRerecordCount() => APIs.Movie.GetRerecordCount();
|
|
|
|
[LuaMethodExample("if ( movie.getrerecordcounting( ) ) then\r\n\tconsole.log( \"Returns whether or not the current movie is incrementing rerecords on loadstate\" );\r\nend;")]
|
|
[LuaMethod("getrerecordcounting", "Returns whether or not the current movie is incrementing rerecords on loadstate")]
|
|
public bool GetRerecordCounting() => APIs.Movie.GetRerecordCounting();
|
|
|
|
[LuaMethodExample("if ( movie.isloaded( ) ) then\r\n\tconsole.log( \"Returns true if a movie is loaded in memory ( play, record, or finished modes ), false if not ( inactive mode )\" );\r\nend;")]
|
|
[LuaMethod("isloaded", "Returns true if a movie is loaded in memory (play, record, or finished modes), false if not (inactive mode)")]
|
|
public bool IsLoaded() => APIs.Movie.IsLoaded();
|
|
|
|
[LuaMethodExample("local domovlen = movie.length( );")]
|
|
[LuaMethod("length", "Returns the total number of frames of the loaded movie")]
|
|
public double Length() => APIs.Movie.Length();
|
|
|
|
[LuaMethodExample("local stmovmod = movie.mode( );")]
|
|
[LuaMethod("mode", "Returns the mode of the current movie. Possible modes: \"PLAY\", \"RECORD\", \"FINISHED\", \"INACTIVE\"")]
|
|
public string Mode() => APIs.Movie.Mode();
|
|
|
|
[LuaMethodExample("movie.save( \"C:\\moviename.ext\" );")]
|
|
[LuaMethod("save", "Saves the current movie to the disc. If the filename is provided (no extension or path needed), the movie is saved under the specified name to the current movie directory. The filename may contain a subdirectory, it will be created if it doesn't exist. Existing files won't get overwritten.")]
|
|
public void Save(string filename = "") => APIs.Movie.Save(filename);
|
|
|
|
[LuaMethodExample("movie.setreadonly( false );")]
|
|
[LuaMethod("setreadonly", "Sets the read-only state to the given value. true for read only, false for read+write")]
|
|
public void SetReadOnly(bool readOnly) => APIs.Movie.SetReadOnly(readOnly);
|
|
|
|
[LuaMethodExample("movie.setrerecordcount( 20.0 );")]
|
|
[LuaMethod("setrerecordcount", "Sets the rerecord count of the current movie.")]
|
|
public void SetRerecordCount(double count) => APIs.Movie.SetRerecordCount((ulong) count.AsInteger());
|
|
|
|
[LuaMethodExample("movie.setrerecordcounting( true );")]
|
|
[LuaMethod("setrerecordcounting", "Sets whether or not the current movie will increment the rerecord counter on loadstate")]
|
|
public void SetRerecordCounting(bool counting) => APIs.Movie.SetRerecordCounting(counting);
|
|
|
|
[LuaMethodExample("movie.stop( );")]
|
|
[LuaMethod("stop", "Stops the current movie")]
|
|
public void Stop() => APIs.Movie.Stop();
|
|
|
|
[LuaMethodExample("local domovget = movie.getfps( );")]
|
|
[LuaMethod("getfps", "If a movie is loaded, gets the frames per second used by the movie to determine the movie length time")]
|
|
public double GetFps() => APIs.Movie.GetFps();
|
|
|
|
[LuaMethodExample("local nlmovget = movie.getheader( );")]
|
|
[LuaMethod("getheader", "If a movie is active, will return the movie header as a lua table")]
|
|
public LuaTable GetHeader()
|
|
{
|
|
|
|
return APIs.Movie
|
|
.GetHeader()
|
|
.ToLuaTable(Lua);
|
|
}
|
|
|
|
[LuaMethodExample("local nlmovget = movie.getcomments( );")]
|
|
[LuaMethod("getcomments", "If a movie is active, will return the movie comments as a lua table")]
|
|
public LuaTable GetComments()
|
|
{
|
|
return APIs.Movie
|
|
.GetComments()
|
|
.ToLuaTable(Lua);
|
|
}
|
|
|
|
[LuaMethodExample("local nlmovget = movie.getsubtitles( );")]
|
|
[LuaMethod("getsubtitles", "If a movie is active, will return the movie subtitles as a lua table")]
|
|
public LuaTable GetSubtitles()
|
|
{
|
|
return APIs.Movie
|
|
.GetSubtitles()
|
|
.ToLuaTable(Lua);
|
|
}
|
|
}
|
|
}
|