TASEmulators / TASEmulators/BizHawk

Don't marshal `Form` instance to Lua

Open
#4,155 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

re: Lua API/scripting Request: Feature/Enhancement
Dominant language
C#
Stars
2.8k
Forks
468
PR merge metrics
No merged PRs in 30d

Description

https://github.com/TASEmulators/BizHawk/blob/c50a4f4e6acc0aae8c9be66ac8b95c71ddd5a72e/src/BizHawk.Client.EmuHawk/tools/Lua/LuaLibraries.cs#L94-L99
Create a new object with just the published list of callbacks. Maybe some common Form/Control props if people have been using those in the wild.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with src/BizHawk.Client.EmuHawk/tools/Lua/LuaLibraries.cs at lines 94-99 and inspect how the Form instance is currently marshaled into Lua. Identify the published callbacks and decide which commonly used Form or Control properties belong on the replacement object; done means Lua receives that limited object instead of the Form instance.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, lua
Domain
desktop, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.