Method Global:RegisterInstanceEvent [-] [+]

Registers a Map event handler for one instance of a Map.

In Multistate mode (default), events are either registered to the WORLD state (-1) or the MAP states (map ID). These events will only ever trigger on their respective state.

In Compatibility mode, all events are registered to the WORLD state (-1).

ID Event State Parameters Comment
1 ON_INITIALIZE MAP event, instance_data, map
2 ON_LOAD MAP event, instance_data, map
3 ON_UPDATE MAP event, instance_data, map, diff
4 ON_PLAYER_ENTER MAP event, instance_data, map, player
5 ON_CREATURE_CREATE MAP event, instance_data, map, creature
6 ON_GAMEOBJECT_CREATE MAP event, instance_data, map, go
7 ON_CHECK_ENCOUNTER_IN_PROGRESS MAP event, instance_data, map

Synopsis

RegisterInstanceEvent( instance_id, event, function )

RegisterInstanceEvent( instance_id, event, function, shots )

Arguments

number instance_id

ID of an instance of a Map.

Valid numbers: integers from 0 to 4,294,967,295.

number event

Map event ID, refer to table above.

Valid numbers: integers from 0 to 4,294,967,295.

function function

Function to register.

number shots (0)

The number of times the function will be called, 0 means "always call this function".

Valid numbers: integers from 0 to 4,294,967,295.

Returns

Nothing.

Generated on
© 2010 - 2024 Eluna Lua Engine