scpt_register_objtype_augmentation

March 26, 2020 Contributors

Name

scpt_register_objtype_augmentation — Manually augment a set of methods for an objtype

Synopsis

#include "modules/scriptlets/ec_scriptlet.h"

| int **scpt_register_objtype_augmentation** ( | type_name, |   |
|   | methods); |   |

const char * <var class="pdparam">type_name</var>;
struct scpt_obj_method * <var class="pdparam">methods</var>;

Description

Note

This reference page was automatically generated from functions found in the header files in the development branch. The function described here may not exist in generally available versions of Momentum, and may change in behavior when it is generally available. Consult your vendor for definitive advice on the use of this function.

Manually augment a set of methods for an objtype.

Ideally, the API scanning tool will do a fine job of generating wrappers for the C APIs, but in some cases it is necessary to provide additional functions to improve the usability of the generated code.

An example of this is providing metamethods to string-like objects.

Call scpt_register_objtype_augmentation prior to the auto-generated scpt_register_objtype call for this to kick in.