Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
- Description
The OnDestroyPlayerOrGroup event is triggered when using the TDx_Play::ReceiveEx() method in the TDx_Play::OnReceive() event. This event indicates that DPMSG_DESTROYPLAYERORGROUP has been received by the component's event thread.
DPMSG_DESTROYPLAYERORGROUP is sent to all players when a player or group is explicitly destroyed by TDx_Play::DestroyGroup() or TDx_Play::DestroyPlayer() or implicitly by TDx_Play::Close().
If the component has created several players with TDx_Play::CreatePlayer() then several events will be triggered, one for each player.
- Parameters
Flags
The Flags parameter defines flags indicating the type of player or group being destroyed.
The described effect applies when the flag is set.
-
DPGROUP_HIDDEN
The group was a hidden group.
DPGROUP_STAGINGAREA
The group was a staging area.
DPPLAYER_SERVERPLAYER
The player was a server player for client/server communications.
DPPLAYER_SPECTATOR
The player was a spectator player.
The Id parameter identifies the player or group being destroyed.
IdParent
The IdParent parameter identifies the parent group of the group being destroyed.
Will be zero unless the group being destroyed was created by TDx_Play::CreateGroupInGroup().
LocalData
The LocalData parameter references any local data associated with the player or group.
LocalDataSize
The LocalDataSize parameter defines the size, in bytes, of the data referenced by LocalData.
Name
The Name parameter references a TDPName parameter holding the name of the player or group.
PlayerType
The PlayerType parameter defines whether the event applies to a player or a group.
DPPLAYERTYPE_PLAYER will indicate a player, while DPPLAYERTYPE_GROUP indicates that a group is involved.
RemoteData
The RemoteData parameter references any remote data associated with the player or group.
RemoteDataSize
The RemoteDataSize parameter defines the size, in bytes, of the data referenced by RemoteData.
Sender
The Sender parameter refers to the object that signalled the event.
- See Also
- Top
TDx_Play_Library v2.00 Component Reference
|
|
|
[ TDx_Play::OnDestroyPlayerOrGroup() ] [ next: OnError() ] [ prev: OnDestroy() ] __published:
__property TDx_OnDestroyPlayerOrGroup OnDestroyPlayerOrGroup = {read=FOnDestroyPlayerOrGroup, write=FOnDestroyPlayerOrGroup, nodefault};
TDX_PLAY::ONDESTROYPLAYERORGROUP()
[ component event ]
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com. |
|