Mercurial > wow > mylilpony
diff libMyLilPony/libMyLilPony_mountData.lua @ 7:d96c15f7477b
Updated documentation for API.
author | syzler |
---|---|
date | Tue, 05 Apr 2011 02:05:57 +0000 |
parents | 7dfbf42c2d60 |
children | b1e344c17ab5 |
line wrap: on
line diff
--- a/libMyLilPony/libMyLilPony_mountData.lua Tue Apr 05 01:11:23 2011 +0000 +++ b/libMyLilPony/libMyLilPony_mountData.lua Tue Apr 05 02:05:57 2011 +0000 @@ -87,26 +87,41 @@ [75207] = "V"; -- abyssal seahorse }; +--- Checks whether or not the specified spell ID is a ground mount. +-- @param spellId The spell ID of the mount to be checked. +-- @return A Boolean value indicating whether or not the specified spell is a ground mount. function MyLilPony.IsGroundMount(spellId) local entry = MyLilPony_Mounts[spellId]; return entry ~= nil and string.match(entry, "G"); end +--- Checks whether or not the specified spell ID is a flying mount. +-- @param spellId The spell ID of the mount to be checked. +-- @return A Boolean value indicating whether or not the specified spell is a flying mount. function MyLilPony.IsFlyingMount(spellId) local entry = MyLilPony_Mounts[spellId]; return entry ~= nil and string.match(entry, "A"); end +--- Checks whether or not the specified spell ID is an aquatic mount. +-- @param spellId The spell ID of the mount to be checked. +-- @return A Boolean value indicating whether or not the specified spell is an aquatic mount. function MyLilPony.IsAquaticMount(spellId) local entry = MyLilPony_Mounts[spellId]; return entry ~= nil and string.match(entry, "S"); end +--- Checks whether or not the specified spell ID is a Temple of Ahn'Qiraj mount. +-- @param spellId The spell ID of the mount to be checked. +-- @return A Boolean value indicating whether or not the specified spell is a Temple of Ahn'Qiraj mount. function MyLilPony.IsAhnQirajMount(spellId) local entry = MyLilPony_Mounts[spellId]; return entry ~= nil and string.match(entry, "Q"); end +--- Checks whether or not the specified spell ID is a Vash'jir mount. +-- @param spellId The spell ID of the mount to be checked. +-- @return A Boolean value indicating whether or not the specified spell is a Vash'jir mount. function MyLilPony.IsVashjirMount(spellId) local entry = MyLilPony_Mounts[spellId]; return entry ~= nil and string.match(entry, "V");