Reflected objects

Group reflect · 10 exports · from forks/gamexueren/scripthook.h (framework 1.0-beta7-wildm1, SH_API_VERSION 2)

The engine's own method tables, callable by name.

Export	Summary
ShReflectMethod	The function behind a method name, 0 when absent.
ShReflectMethods	Every method of the object's class, in table order.
ShReflectClassHash	The class hash, through the descriptor getter.
ShReflectCall	Call a method by name on the game thread and wait.
ShSceneEnter	A scene is any reflected object with Enter and Exit.
ShSceneExit	See ShSceneEnter.
ShGameFlow	The GR_GameFlow machine, identity checked.
ShGameFlowObject	—
ShHybridMenu	The HybridMenu, the shell every menu page lives in.
ShTriggerGameOver	The real thing: death, card and checkpoint reload.

ShReflectMethod

SH_API int  ShReflectMethod(uint64_t obj, uint32_t nameHash,
                            uint64_t *outFn);

The function behind a method name, 0 when absent.

scripthook.h, line 3092

ShReflectMethods

SH_API int  ShReflectMethods(uint64_t obj, ShMethod *out, int max);

Every method of the object's class, in table order.

scripthook.h, line 3095

ShReflectClassHash

SH_API uint32_t ShReflectClassHash(uint64_t obj);

The class hash, through the descriptor getter.

scripthook.h, line 3097

ShReflectCall

SH_API int  ShReflectCall(uint64_t obj, uint32_t nameHash,
                          uint64_t a1, uint64_t a2, uint64_t a3,
                          uint64_t *outRet);

Call a method by name on the game thread and wait. obj is this; up to three more integer arguments.

scripthook.h, line 3102

ShSceneEnter

SH_API int  ShSceneEnter(uint64_t obj);

A scene is any reflected object with Enter and Exit. Enter refuses objects without Exit, so it can be undone.

scripthook.h, line 3116

ShSceneExit

SH_API int  ShSceneExit(uint64_t obj);

Documented together with ShSceneEnter just above.

scripthook.h, line 3117

ShGameFlow

SH_API uint64_t ShGameFlow(void);

The GR_GameFlow machine, identity checked.

scripthook.h, line 3120

ShGameFlowObject

SH_API uint64_t ShGameFlowObject(int slot);

No doc comment in the header.

scripthook.h, line 3127

ShHybridMenu

SH_API uint64_t ShHybridMenu(void);

The HybridMenu, the shell every menu page lives in.

scripthook.h, line 3130

ShTriggerGameOver

SH_API int  ShTriggerGameOver(int reason);

The real thing: death, card and checkpoint reload. Reason 1 is the one verified in game.

scripthook.h, line 3135