#[meta] lua cutscenes recipe book

23 messages · Page 1 of 1 (latest)

left pumice
#

i find that when people are learning how to use lua cutscenes, the only available resources are the mod page, documentation, and helper_functions.lua.

it would be nice to have a recipe book of sorts (on the everest mod resources page?) with more complex cutscenes along with what they do and why, stepping through the 'tiers' of complexity (basic lua syntax; movement/dialogue; c# calls; more complicated interactions; coroutine/async stuff; making new coroutines; reflection?)

does anyone have any feedback re. the content / structure of such a resource?

north abyss
#

not much other than that sounds like a great idea

left pumice
#

@west path what are the conditions for getting private stuff from lua? apparently you can just get it without worrying about reflection (i.e. everything's dynamic), is this reliable / something i should put in the recipe book?
see #1000145630548742154 message

left pumice
north abyss
#

changed the decompiling link to point to the section on the code modding page, which is slightly more in depth

west path
#

i dont see why not >_< but is this preferable to having it baked into the mod documentation?

#

Lua Cutscenes provides many helper functions that let you do things in your cutscenes; a full list is available here, and the lua code those functions are written in is here.

Second link goes to one of the example cutscenes, not the helper definition file

#

onBegin should have the room parameter for completion sake

left pumice
#
  • at the moment the documentation is mostly just stuff on each function rather than overarching stuff, so it would be nice to have a separate resource that doesn't cover as many details
  • having it as a wiki rather than in the source makes it easier for people to add more recipes, which i think is important
  • having it as a written thing rather than generated from source makes it easier to curate a progression from simpler → more complex
west path
#

the Lua docs can be written as complete standalone pages though 😓

#

but i dont disagree

left pumice
west path
#

i have no damn clue haha

#

it does whatever NLua / Jade figured out the metamagic should do

#

i can go read the Lua loader really quick

#

if members is everything, then those are getting with binding flag all

left pumice
#

i mean nlua.org says

All methods, events or property need to be public available, NLua will fail to call non-public members.

#

so i'm not sure what's happening

west path
left pumice
#

ah yea that'd do it. seems safe to document then

west path
#

from what i remember members is literally everything in a class

#

so yes haha