LSModule:Ventrilo:ventriloelement (Object Type)
Jump to navigation
Jump to search
Contents
Description
| ventriloelement | |
| Defined By | Ventrilo LSModule |
| Inherits | none |
| Reduces To | Same as Name |
| Variable Object Type | none |
| Uses Sub-Types | no |
| C/C++ Type | void* |
Members
- uint ID
- A globally-unique ID differentiating this element from every other ventriloelement. This ID can be passed to the Ventrilo Top-Level Object to refer to the element at any time. The ID is unique across all instances of Ventrilo (thusly globally-unique), so regardless of another instance being opened, the ID will never get mixed up with another element.
- ... Parent
- The parent of this element. This could be a ventriloinstance, ventriloserver, or ventrilochannel under normal circumstances.
- ... Children
- The first child of this element (if any)
- ... Next
- The next sibling of this element (if any)
- ... Previous
- The previous sibling of this element (if any)
- ... WalkTree
- The next element in the tree, by walking the tree (can be used to iterate all elements)
- string Type
- Will be one of "Instance","Server","Channel","User"
- ventriloinstance Instance
- The instance containing this element
- string Icon
- The filename of the icon in use. See Ventrilo documentation for the complete list (click Help in the Ventrilo window). Example: "voiceon.ico"
- uint IconID
- The numeric ID of the icon currently in use for this element
- string DisplayText
- The full display text for this element in the Ventrilo window (including status flags, rank, name, comment, etc)
- string Name
- The name of this element
- string Pronunciation
- The text-to-speech pronunciation hint for this element
- string Comment
- The comment for this element (will be identical to CommentURL if a comment URL is set)
- string CommentURL
- The comment URL for this element
- string Rank
- The Rank (including custom prefix and suffix as defined in the Ventrilo settings) for this element
- uint RankID
- The ID of the rank for this element (starting with 1, going down the current Ventrilo server's rank list from the top)
- uint Flags
- Bit-flags describing the status for this element (based on the Ventrilo status flags "A" "N" etc)
- bool IsAdmin
- TRUE if this element has the "A" flag
- bool HasChatWindowOpen
- TRUE if this element has the "C" flag
- bool IsChannelMuted
- TRUE if this element has the "N" flag
- bool IsGlobalMuted
- TRUE if this element has the "G" flag
- bool IsLocalMuted
- TRUE if this element has the "M" flag
- bool IsMuted
- TRUE if this element has ANY mute flag
- bool IsPlayingTTS
- TRUE if this element has the "T" flag
- bool IsPlayingWAV
- TRUE if this element has the "W" flag
- bool HasEffect
- TRUE if this element has the "S" flag
- bool IsPhantom
- TRUE if this element has the "P" flag
- bool IsSelected
- TRUE if this element is the selected item in the Ventrilo window
- string GetMetadata[name]
- Retrieves the value of the custom metadata field with the given name
Methods
- SetMetadata[name,value]
- Attaches a custom metadata field to this object. Any number of metadata values may be stored.
- UnsetMetadata[name]
- Removes a custom metadata field from this object
- Select
- Causes this element to be selected in the Ventrilo window
Examples
See Also
- ventriloinstance - An instance of the Ventrilo application
- ventrilochannel
- ventrilouser
