This site has been archived and made available for preservation purposes. No edits can be made.

GetConnection

(Difference between revisions)
Return to current revision
  1.  
    Returns the assigned connection slot of the given [wiki]ID[/wiki] (which must reflect a [wiki]Player[/wiki]).
    [h="2"] Declaration [/h]
    [highlight=cpp]
    VAULTSCRIPT VAULTSPACE UCount (*VAULTAPI(GetConnection))(VAULTSPACE ID) VAULTCPP(noexcept);
    [/highlight]
    [highlight=c]
    native GetConnection(ID);
    [/highlight]
    [h="2"] Parameters [/h]
    [b][wiki="ID"]ID[/wiki][/b] - the ID of the [wiki]Player[/wiki]
    [h="2"] Return value [/h]
  2. -
    Returns a [wiki="UCount"]UCount[/wiki], which is a value within the range [0, [wiki]GetMaximumPlayers[/wiki]). If the given [wiki]ID[/wiki] does not reflect a [wiki]Player[/wiki], UINT_MAX is returned.
  3. +
    Returns a [wiki="UCount"]UCount[/wiki], which is a value within the range [0, [wiki]GetMaximumPlayers[/wiki] - 1]. If the given [wiki]ID[/wiki] does not reflect a [wiki]Player[/wiki], UINT_MAX is returned.
  4.  
    [category]VaultMP interface[/category]
    [category]Scripting functions[/category]
    [category]Game functions[/category]