Eventtype

From Vendetta Lua
Revision as of 23:32, 23 November 2008 by Mick (talk | contribs) (→‎TARGET_SCANNED)
Jump to navigationJump to search

Introduction

Events are used for communication between different parts of the client. For example the chat log is registered to the CHAT_MSG_CHANNEL event. When the client receives a chat message the event is triggered and the received string passed along with it. The event callback in the chat log now appends the string to the log.


A very basic example using the TARGET_CHANGED event. It's triggered whenever the target changes <source lang="lua"> -- define a table. this table is the "object" that gets registered with event target = {}

-- define a function called OnEvent within this table. It's called when the event is triggered. -- It has at least one argument, containing the name of the event that is passed to it function target:OnEvent(event) 

   -- this way it is possible to handle multiple events with one table
   if event == "TARGET_CHANGED" then
       -- the only action is to print something
       print("Target Changed")
   end

end

-- register the table with the event RegisterEvent(target, "TARGET_CHANGED")

</source>


Notes

Calling RegisterEvent twice with the same arguments will result in the same table receiving an event twice, which is generally not wanted. Use ReloadInterface or UnregisterEvent to get rid previously registered tables before registering new ones.


Passing locally defined tables to RegisterEvent doesn't work. example: <source lang="lua"> do 

   local tab = {}
   function tab:OnEvent() print("this doesn't work") end
   RegisterEvent(tab, "MYEVENT")

end </source>

the table needs a strong reference: <source lang="lua"> do 

   local tab = {}
   function tab:OnEvent() print("this does work") end
   RegisterEvent(tab, "MYEVENT")
   tab_strong = tab

end </source>


Eventlist

The client provides a set of predefined events.

Known events are:

ACTIVATE_CHAT_CHANNEL

Description:


ACTIVATE_CHAT_GROUP

Description:


ACTIVATE_CHAT_GUILD

Description:


ACTIVATE_CHAT_MISSION

Description:


ACTIVATE_CHAT_PRIVATE

Description:


ACTIVATE_CHAT_SAY

Description:


ACTIVATE_CHAT_SECTOR

Description:


ACTIVATE_CHAT_USER

Description:


AUTOAIM_MODE_CHANGED

Description:


CHANGE_ACTIVE_CHATTAB

Description:


CHARINFOMENU_TOGGLE

Description:


CHAT_CANCELLED

Description:


CHAT_DONE

Description:


CHAT_MSG_BAR1

Description:
A message from an Itani in the station bar.
Arguments:



CHAT_MSG_BAR2

Description:
A message from a Serco in the station bar.
Arguments:




CHAT_MSG_BAR3

Description:
A message from a UIT in the station bar.

Arguments:



CHAT_MSG_BAR

Description:


CHAT_MSG_BARENTER

Description:
A message stating that a player has entered the bar.

Arguments:



CHAT_MSG_BARLEAVE

Description:
A message stating that a player has left the bar.

Arguments:



CHAT_MSG_BARLIST

Description:
A message listing the players currently in the bar.

Arguments:



CHAT_MSG_BAR_EMOTE1

Description:
An emote (/me) message from an Itani in the station bar.

Arguments:



CHAT_MSG_BAR_EMOTE2

Description:
An emote (/me) message from a Serco in the station bar.

Arguments:



CHAT_MSG_BAR_EMOTE3

Description:
An emote (/me) message from a UIT in the station bar.

Arguments:



CHAT_MSG_BAR_EMOTE

Description:


CHAT_MSG_BUDDYNOTE

Description:


CHAT_MSG_CHANNEL

Description:


CHAT_MSG_CHANNEL_ACTIVE

Description:


CHAT_MSG_CHANNEL_EMOTE

Description:


CHAT_MSG_CHANNEL_EMOTE_ACTIVE

Description:


CHAT_MSG_CONFIRMATION

Description:


CHAT_MSG_DEATH

Description:


CHAT_MSG_ERROR

Description:


CHAT_MSG_GLOBAL_SERVER

Description:


CHAT_MSG_GROUP

Description:
A message from a player in your group.

Arguments:



CHAT_MSG_GUIDE

Description:
A message from a guide.

Arguments:


CHAT_MSG_GUILD

Description:
A message from guildmate.

Arguments:
arg1 = {string msg, string name, int location = sectorid, int faction = factionid}

CHAT_MSG_GUILD_EMOTE

Description:
An emote (/me) message from a guildmate.

Arguments:
arg1 = {string msg, string name, int location = sectorid, int faction = factionid}

CHAT_MSG_GUILD_MOTD

Description:
Not used, instead guild MOTD triggers CHAT_MSG_SERVER event. The guild MOTD.

CHAT_MSG_GROUP_NOTIFICATION

Description:


CHAT_MSG_INCOMINGBUDDYNOTE

Description:


CHAT_MSG_MISSION

Description:


CHAT_MSG_MOTD

Description:


CHAT_MSG_NATION

Description:
A message on nation chat. Depricated/unused.

CHAT_MSG_PRINT

Description:


CHAT_MSG_PRIVATE

Description:

An incoming private message from another player.

Arguments:

arg1 = {string msg, string name}

CHAT_MSG_PRIVATEOUTGOING

Description:
An outgoing private message to another player.

Arguments:



CHAT_MSG_SECTOR

Description:
A message from a player in the sector.

Arguments:



CHAT_MSG_SECTORD

Description:
A message from the sector daemon.

Arguments:



CHAT_MSG_SECTORD_MISSION

Description:
A mission message from the sector daemon.

Arguments:



CHAT_MSG_SECTORD_SECTOR

Description:
A sector message from the sector daemon (temp KOS standing messages and the 'You've been caught in an Ion Storm.' messages)

Arguments:



CHAT_MSG_SECTOR_EMOTE

Description:
An emote (/me) message from a player in-sector.

Arguments:



CHAT_MSG_SERVER

Description:


CHAT_MSG_SERVER_CHANNEL

Description:


CHAT_MSG_SERVER_CHANNEL_ACTIVE

Description:


CHAT_MSG_SERVER_GUILD

Description:


CHAT_MSG_SERVER_SECTOR

Description:


CHAT_MSG_SYSTEM

Description:
A message from another player in your system.

Arguments:



CHAT_SCROLL_DOWN

Description:


CHAT_SCROLL_UP

Description:


CINEMATIC_START

Description:
Called when an ingame cinematic is started. Examples include the undocking animation and the warping sequences.

Arguments:



COMMAND

Description:


DESIRED_SPEED_CHANGED

Description:


ENTERED_STATION

Description:


ENTERING_STATION

Description:


ENTER_ZONE_NFZ

Description:


FLIGHT_MODE_CHANGED

Description:


FORGIVENESS_DIALOG

Description:


GROUP_CREATED

Description:


GROUP_MEMBER_DIED

Description:


GROUP_MEMBER_HEALTH_UPDATE

Description:


GROUP_MEMBER_JOINED

Description:


GROUP_MEMBER_KILLED

Description:


GROUP_MEMBER_LEFT

Description:


GROUP_MEMBER_LOCATION_CHANGED

Description:


GROUP_MEMBER_UPDATE

Description:


GROUP_OWNER_CHANGED

Description:


GROUP_SELF_INVITED

Description:


GROUP_SELF_JOINED

Description:


GROUP_SELF_LEFT

Description:


GUILD_ACTIVITY_LOG

Description:


GUILD_BALANCE_UPDATED

Description:


GUILD_BANK_LOG

Description:


GUILD_MEMBERS_UPDATED

Description:


GUILD_MEMBER_ADDED

Description:
Triggered when guild member logs on or joins the guild. Arguments:
charid charid of added guild member.

GUILD_MEMBER_REMOVED

Description:
Triggered when guild member logs off or leaves the guild. Arguments:
charid charid of removed guild member.

GUILD_MEMBER_UPDATED

Description:


GUILD_MOTD_UPDATED

Description:


GUILD_PRIVILEGES_UPDATED

Description:


HUD_HELP_TOGGLE

Description:


HUD_HIDE

Description:


HUD_INVENTORY_TOGGLE

Description:


HUD_MODE_TOGGLE

Description:


HUD_SHOW

Description:


HUD_SKIRMISH_CLOSE

Description:


HUD_SKIRMISH_OPEN

Description:


HUD_SKIRMISH_UPDATE

Description:


HUD_TOGGLE

Description:


HUD_UPDATE

Description:


INVENTORY_ADD

Description:


INVENTORY_RECEIVED

Description:


INVENTORY_REMOVE

Description:


INVENTORY_UPDATE

Description:


JETTISONMENU_TOGGLE

Description:


JUMP_OUT_CINEMATIC_FINISHED

Description:
Called when the sector jump-out cinematic is finished.

Arguments:



LEAVE_ZONE_NFZ

Description:


LEAVING_STATION

Description:


LOGIN_FAILED

Description:


LOGIN_SUCCESSFUL

Description:


MISSIONLIST_UPDATED

Description:


MISSION_ADDED

Description:


MISSION_NOTIFICATION

Description:


MISSION_QUESTION_OPEN

Description:


MISSION_REMOVED

Description:


MISSION_TIMER_START

Description:


MISSION_TIMER_STOP

Description:


MISSION_UPDATED

Description:


MSG_LOGOFF_TIMER

Description:


MSG_NOTIFICATION

Description:


NAVMENU_TOGGLE

Description:


NAVROUTE_ADD

Description:


NAVROUTE_CHANGED

Description:


NAVROUTE_SAVE

Description:


NAVROUTE_UNDOLAST

Description:


OBJECT_INFO_UPDATED

Description:


OPEN_SURVEY

Description:


PLAYERLIST_TOGGLE

Description:


PLAYER_DIED

Description:


PLAYER_ENTERED_GAME

Description:


PLAYER_ENTERED_SECTOR

Description:


PLAYER_GOT_HIT

Description:


PLAYER_GUILD_TAG_UPDATED

Description:


PLAYER_HIT

Description:


PLAYER_HOME_CHANGED

Description:


PLAYER_LEFT_SECTOR

Description:


PLAYER_LOGGED_OUT

Description:


PLAYER_RECEIVED_NEW_ACCOMPLISHMENTS

Description:


PLAYER_STATS_UPDATED

Description:


PLAYER_UPDATE_ACCOMPLISHMENTS

Description:


PLAYER_UPDATE_FACTIONSTANDINGS

Description:


PLAYER_UPDATE_SKILLS

Description:


PLAYER_UPDATE_STATS

Description:


PROXIMITY_ALERT

Description:


SECTOR_ALIGNMENT_UPDATED

Description:


SECTOR_CHANGED

Description:


SECTOR_LOADED

Description:


SECTOR_LOADING

Description:


SERVER_DISCONNECTED

Description:


SHIP_CHANGED

Description:


SHIP_SPAWNED

Description:


SHIP_UPDATED

Description:


SHOW_STATION

Description:


START

Description:


STATION_TURRET_HEALTH_UPDATE

Description:


STATION_UPDATED

Description:


STATION_UPDATE_DESIREDITEMS

Description:


STATION_UPDATE_PRICE

Description:


STATION_UPDATE_REQUESTED

Description:


STORM_STARTED

Description:


STORM_STOPPED

Description:


SYSMENU_TOGGLE

Description:


TARGET_CHANGED

Description:


TARGET_HEALTH_UPDATE

Description:


TARGET_SCANNED

Description:
Triggered when asteroid is scanned.
Arguments:(scaninfo, nodeid, objectid)

scaninfo string containing information on ores contained by the roid. Same thing that's displayed in top right corner of the hud (HUD.scaninfo.title)
nodeid nodeid of scanned roid.
objectid objectid of scanned roid.


TERMINATE

Description:


TRANSACTION_COMPLETED

Description:


TRANSACTION_FAILED

Description:


UNLOAD_INTERFACE

Description:
Raised when interface is about to be reloaded.

Arguments:



UPDATE_BUDDY_LIST

Description:


UPDATE_CHARACTER_LIST

Description:


UPDATE_CHARINFO

Description:


UPDATE_DUEL_INFO

Description:


UPDATE_NEWS

Description:


UPDATE_NEWS_HEADLINES

Description:


VOICECHAT_PLAYER_LISTEN_STATUS

Description:


VOICECHAT_PLAYER_MUTE_STATUS

Description:


VOICECHAT_PLAYER_TALK_STATUS

Description:


WARP_OUT_CINEMATIC_FINISHED

Description:
Called when the wormhole warp-out cinematic is finished.

Arguments:



WEAPON_GROUP_CHANGED

Description:


WEAPON_PROGRESS_START

Description:


WEAPON_PROGRESS_STOP

Description:


rHUDxscale

Description:


Retrieved from "https://vo-wiki.com/racecar2/index.php?title=Eventtype&oldid=439"