Cutscene

Adds a new callback for the end of this cutscene.

@param func — The callback function to set or append to this cutscene.

@param replace — Whether or not to overwrite all previously defined callbacks on this function.

(Called internally) (Override) Checks whether the cutscene is currently in a state suitable to be ended.

@return can_end — Whether the cutscene is able to be ended.

(Called internally) Checks whether the cutscene is ready to resume.

@return ready — Whether the cutscene is ready to resume.

@return a

@return b

@return c

@return d

@return e

@return f

Adds a new during callback to this cutscene.
During callbacks run once every frame during cutscenes, and they can remove themselves from the cutscene by returning false.

@param func — The function to be run.

@param replace — Whether the new callback should replace all currently active during callbacks.

Ends the cutscene.

Starts executing a new cutscene script specified by func.

@param func — The new cutscene script.

@param ... — Additional arguments to pass to the new cutscene.

(Called internally) Internal callback for when cutscenes end.
Also responsible for calling user defined callbacks from Cutscene:after()

Indefinitely pausees the cutscene.

Plays a sound.

@return finished — A function that returns true once the sound has stopped playing.

Resumes the cutscene if it had been previously paused.

@param ... — Additional arguments that will be returned by the adjacent Cutscene:wait() call.

(Called internally) Checks whether the cutscene is ready to be resumed, and resumes it if the check succeeds.
Any additional return values from Cutscene:canResume() are passed through into Cutscene:resume(...).

@return success — Whether the cutscene successfully resumed.

(Override) Runs once every frame that the cutscene instance exists (including when suspended).
New cutscene types should always call super.update(self) if they override this function!
See: Cutscene.during if you are looking to run code every frame in a cutscene script.

Temporarily suspends execution of the cutscene script.

@param seconds — When a number, waits this number of seconds before continuing. When a function, waits until this function returns true. (Defaults to 0)

@return ... — Any values passed into the adjacent Cutscene:resume(...) call.