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

AxisToString

(Difference between revisions)
Return to current revision
  1. -
    Retrieves the string representation of an [[Axis]].

    == Declaration ==
    <code cpp>
    VAULTSCRIPT std::string (*AxisToString)(vaultmp::Index);
    native AxisToString(index, value{});
    </code>
    == Parameters ==

    '''[[Index|vaultmp::Index]]''' - the index of the [[Axis]]

    '''value''' (PAWN only) - an array large enough to hold at least 64 characters

    == Return value ==

    The C++ version returns a std::string containing the string representation of the axis. The PAWN version has no return value.

    == Usage example (C++) ==

    <code cpp>
    std::string value;
    value = AxisToString(index);
    </code>

    == Usage example (PAWN) ==

    <code c>
    new value{64};
    AxisToString(index, value);
    </code>