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

GetBase

(Difference between revisions)
Return to current revision
Current Revision 11-17-2012, 01:16 AM
  1. -
    Retrieves the base of an [[Object]].

    == Declaration ==
    <code cpp>
    VAULTSCRIPT vaultmp::Base (*GetBase)(vaultmp::ID);
  2. +
    Retrieves the base of an [wiki]Object[/wiki].
    [h="2"] Declaration [/h]
    [highlight=cpp]
    VAULTSCRIPT VAULTSPACE Base (*VAULTAPI(GetBase))(VAULTSPACE ID) VAULTCPP(noexcept);
    [/highlight]
    [highlight=c]
  3.  
    native GetBase(ID);
  4. -
    </code>
    == Parameters ==

    '''[[ID|vaultmp::ID]]''' - the ID of the [[Object]]

    == Return value ==

    Returns a [[Base|vaultmp::Base]] containing the base.

    == Usage example (C++) ==

    <code cpp>
    vaultmp::Base baseID;
    baseID = GetBase(object);
    </code>
  5. +
    [/highlight]
    [h="2"] Parameters [/h]
    [b][wiki="ID"]ID[/wiki][/b] - the ID of the [wiki]Object[/wiki]
    [h="2"] Return value [/h]
    Returns a [wiki="Base"]Base[/wiki].
    [category]VaultMP interface[/category]
    [category]Scripting functions[/category]
    [category]Object functions[/category]