SetJohnnyOnRenderUpdateEventHandler

From GECK
Jump to: navigation, search


A function added by the JohnnyGuitar NVSE Plugin.

Description

Sets/removes the specified UDF Script as a handler that will be executed every frame before the frame is rendered.
Due to the nature of this event, it should only be used for situations where frame-wide synchronization is required. Any other action shall be done outside it, i.e. using SetGameMainLoopCallback.

Syntax

[help]
SetJohnnyOnRenderUpdateEventHandler setORremove:1/0 handlerScript:ref flag:int 

Or:

SetOnRenderUpdateEventHandler setORremove:1/0 handlerScript:ref flag:int

Example

SetJohnnyOnRenderUpdateEventHandler 1 OnRenderUpdateUDF 0

Sets the OnRenderUpdateUDF script as a handler to be executed every frame before it's rendered.

SetJohnnyOnRenderUpdateEventHandler 0 OnRenderUpdateUDF 0

Removes the OnRenderUpdateUDF script as a handler of the above.

Handler Script

A skeleton handler script for this event:

scn OnRenderUpdateUDF 

begin Function {} 

...

end

Notes

  • Flag argument is reserved for future use and should always be 0.

See Also