Developer

API Reference

ITRIGPLAYEREX_SetName()

deprecated
Items marked as deprecated have been replaced by a more powerful, alternative feature. Deprecated interfaces include a reference to the replacement interface, which should be used for all new application development. Deprecated features are still supported for backward compatibility, but should be avoided when developing new applications.
Brew Release
Brew MP 1.0.2
See Also
ITRIGPLAYEREX_GetName() ITRIGPLAYEREX_Split()
Description
Assigns a new name to this TrigPlayer widget.
Parameters
  • po
    []:
    A pointer to an ITrigplayerEx object.
  • newName
    []:
    The new name of the TrigPlayer widget. This must not be NULL, must not be the string "default", and must be unique among all TrigPlayers that are Split() from the same original player.

Interface
ITRIGPLAYEREX
Prototype
   int ITRIGPLAYEREX_SetName(ITrigplayerEx* po, const AECHAR* newName);
Return
   A BREW error code.  In particular, EALREADY indicates that a TrigPlayer
   widget with that name already exists among those that have been split from
   the same original TrigPlayer widget.
Side Effect
None
Comment
The name of a TrigPlayer widget is the name of its corresponding child node in /players. This is assigned by calling either ITRIGPLAYEREX_SetName() or by calling ITRIGPLAYEREX_Split().
If a name has not been explicitly assigned to a TrigPlayer, its name is "default". You can use this method to change the name of a TrigPlayer, but you must do so BEFORE loading content or otherwise observing /players or /players/default.
  • Follow