ryzom/server/src/server_share/chat_unifier_itf.xml

   1 <generator header_tag="CHAT_UNIFIER_ITF">
   2
   3         <include file="nel/misc/entity_id.h"/>
   4         <cpp-include file="stdpch.h"/>
   5
   6         <namespace name="CHATUNI">
   7
   8                 <!-- ############################################################## -->
   9                 <enum name="TFailInfo">
  10                         <doc line="The player locator is not available, could'nt do the job"/>
  11                         <item name="fi_no_entity_locator"/>
  12
  13                         <doc line="No IOS module for the addresse hosting shard"/>
  14                         <item name="fi_no_ios_module"/>
  15
  16                         <doc line="No character synchronizer to retreive sender name"/>
  17                         <item name="fi_no_char_sync"/>
  18
  19                         <doc line="The sender character is unknown"/>
  20                         <item name="fi_sender_char_unknown"/>
  21
  22                         <doc line="The addressee character is unknown"/>
  23                         <item name="fi_dest_char_unknown"/>
  24
  25                         <doc line="The addressee character is offline"/>
  26                         <item name="fi_char_offline"/>
  27
  28                 </enum>
  29
  30                 <!-- ############################################################## -->
  31                 <module_interface name="CChatUnifier">
  32                         <doc line="Interface used by IOS, implemented by SU to send"/>
  33                         <doc line="char related message to unifier."/>
  34
  35                         <!-- ========================================================== -->
  36                         <method name="sendFarTell" msg="CUSFT">
  37                                 <doc line="IOS forward a tell message to the unifier"/>
  38                                 <doc line="If IOS can't find the player localy, it forward"/>
  39                                 <doc line="the tell to the unifier"/>
  40
  41                                 <param type="NLMISC::CEntityId"         name="senderCharId" byref="true"/>
  42                                 <param type="bool"                      name="havePrivilege" />
  43                                 <param type="ucstring"          name="destName"         byref="true"/>
  44                                 <param type="ucstring"          name="text"                     byref="true"/>
  45                         </method>
  46
  47                         <!-- ========================================================== -->
  48 <!--                    <method name="sendFarGuildChat" msg="CUSFGC">
  49                                 <doc line="IOS forward a guild chat message to the unifier"/>
  50
  51                                 <param type="NLMISC::CEntityId"         name="senderCharId" byref="true"/>
  52                                 <param type="uint32"            name="guildId"/>
  53                                 <param type="ucstring"          name="text"             byref="true"/>
  54                         </method>
  55 -->
  56                         <!-- ========================================================== -->
  57 <!--                    <method name="sendFarGuildChat2" msg="CUSFGC2">
  58                                 <doc line="IOS forward a guild chat message to the unifier"/>
  59                                 <doc line="This version use a translated string name as chat content"/>
  60
  61                                 <param type="NLMISC::CEntityId"         name="senderCharId" byref="true"/>
  62                                 <param type="uint32"            name="guildId"/>
  63                                 <param type="ucstring"          name="phraseName"       byref="true"/>
  64                         </method>
  65 -->
  66
  67                         <!-- ========================================================== -->
  68 <!--                    <method name="sendFarGuildChat2Ex" msg="CUSFGC2E">
  69                                 <doc line="IOS forward a guild chat message to the unifier"/>
  70                                 <doc line="This version use a translated string ID as chat content"/>
  71
  72                                 <param type="NLMISC::CEntityId"         name="senderCharId" byref="true"/>
  73                                 <param type="uint32"            name="guildId"/>
  74                                 <param type="uint32"            name="phraseId"/>
  75                         </method>
  76 -->
  77
  78                 </module_interface>
  79
  80                 <!-- ############################################################## -->
  81                 <module_interface name="CChatUnifierClient">
  82                         <doc line="Interface used by SU, implemented by IOS to send"/>
  83                         <doc line="char related message to IOS."/>
  84
  85                         <!-- ========================================================== -->
  86                         <method name="recvFarTellFail" msg="CURFTF">
  87                                 <doc line="SU send a far tell failure to IOS. This mean that the player is offline or unknow"/>
  88
  89                                 <param type="NLMISC::CEntityId"         name="senderCharId" byref="true"/>
  90                                 <param type="ucstring"          name="destName" byref="true"/>
  91                                 <param type="TFailInfo"         name="failInfo" enum="start"/>
  92                         </method>
  93
  94                         <!-- ========================================================== -->
  95                         <method name="recvFarTell" msg="CURFT">
  96                                 <doc line="SU send a far tell to the IOS hosting the addresse character"/>
  97
  98                                 <param type="NLMISC::CEntityId"         name="senderCharId" byref="true"/>
  99                                 <param type="ucstring"          name="senderName"       byref="true"/>
 100                                 <param type="bool"                      name="havePrivilege"/>
 101                                 <param type="ucstring"          name="destName"         byref="true"/>
 102                                 <param type="ucstring"          name="text"                     byref="true"/>
 103                         </method>
 104
 105                         <!-- ========================================================== -->
 106                         <method name="farGuildChat" msg="CURFGC" broadcast="true">
 107                                 <doc line="IOS forward a guild chat message to the IOS"/>
 108
 109                                 <param type="ucstring"                  name="senderName"       byref="true"/>
 110                                 <param type="uint32"                    name="guildId"/>
 111                                 <param type="ucstring"                  name="text"                     byref="true"/>
 112                         </method>
 113
 114                         <!-- ========================================================== -->
 115                         <method name="farGuildChat2" msg="CURFGC2" broadcast="true">
 116                                 <doc line="IOS forward a guild chat message to the IOS"/>
 117
 118                                 <param type="ucstring"                  name="senderName"       byref="true"/>
 119                                 <param type="uint32"                    name="guildId"/>
 120                                 <param type="ucstring"                  name="phraseName"       byref="true"/>
 121                         </method>
 122
 123                         <!-- ========================================================== -->
 124                         <method name="farGuildChat2Ex" msg="CURFGC2E" broadcast="true">
 125                                 <doc line="IOS forward a guild chat message to the IOS"/>
 126
 127                                 <param type="ucstring"                  name="senderName"       byref="true"/>
 128                                 <param type="uint32"                    name="guildId"/>
 129                                 <param type="uint32"                    name="phraseId"/>
 130                         </method>
 131
 132                         <!-- ========================================================== -->
 133                         <method name="universeBroadcast" msg="CURUB" broadcast="true">
 134                                 <doc line="IOS forward a univers chat message to the IOSs"/>
 135
 136                                 <param type="ucstring"                  name="senderName"       byref="true"/>
 137                                 <param type="uint32"                    name="senderHomeSession"/>
 138                                 <param type="ucstring"                  name="text"                     byref="true"/>
 139                         </method>
 140
 141                         <!-- ========================================================== -->
 142                         <method name="dynChanBroadcast" msg="CUDCB" broadcast="true">
 143                                 <doc line="IOS forward a dyn chat chat message to the IOSs"/>
 144
 145                                 <param type="NLMISC::CEntityId" name="chanId"           byref="true"/>
 146                                 <param type="ucstring"                  name="senderName"       byref="true"/>
 147                                 <param type="ucstring"                  name="text"                     byref="true"/>
 148                         </method>
 149
 150                         <!-- ========================================================== -->
 151                         <method name="recvBroadcastMessage" msg="CURBM">
 152                                 <doc line="SU send a broadcast message to the IOS"/>
 153
 154                                 <param type="ucstring"                  name="message"          byref="true"/>
 155                         </method>
 156
 157                 </module_interface>
 158
 159         </namespace>
 160 </generator>
 161