The "vngen_goto" Function

Syntax

vngen_goto(event, [object], [perform]);
ArgumentTypeDescription
eventinteger/stringThe Quantum event to go to (numeric ID or label)
[object]objectOptional: The object containing the target event (default: self)
[perform]booleanOptional: Enables or disables performing skipped events (default: enabled)

Description

Jumps from the current Quantum event to a different one, creating the containing object and destroying the current object, if necessary. This is a very important script, as its most common uses include restoring saved locations and navigating to different story branches from dialog options.

By default, running this script will perform skipped events in the background before arriving at the target event. This is necessary so that the target event will appear as if the user had viewed each event normally. To disable this behavior and perform only the target event, the optional 'perform' argument may be set to 'false'. Note that an object must be supplied in order to disable performing skipped events.

note

Tip: The keyword 'self' can be supplied in place of an object to target an event in the current object.

Note that vngen_goto is not an action, and therefore requires being wrapped in vngen_script_execute to behave as one. The exception to this is when used in conjunction with vngen_get_option in a dialog option segment: as vngen_get_option is itself not an action either (but behaves like one), in this case vngen_goto should be used normally.

Example

vngen_goto(5, obj_script);
vngen_goto("my_event");
vngen_goto(10, self, false);