R/strings.R

#' @include getStrings.R

#' @name strings.general
#' @title Strings for general stats
#' @description A set of substitutable strings for general statistcs, like in-game names, IDs, etc.
#' @docType data
#' @keywords datasets
#' @usage strings.general
#' @note \code{\link[wurstmineR]{getStrings}} can be used to update this dataset, or be used to create your own.
#' @format a \code{data.frame} containing name, id, category, unit and scale.
#' @author Farthen, Fenhl
#' @source Wurstmineberg; see \url{http://assets.wurstmineberg.de}
#' and \url{https://github.com/wurstmineberg/assets.wurstmineberg.de}
"strings.general"
#' @name strings.items
#' @title Strings for item stats
#' @description A set of substitutable strings for item statistcs, like in-game names, IDs…
#' @docType data
#' @keywords datasets
#' @usage strings.items
#' @note \code{\link[wurstmineR]{getStrings}} can be used to update this dataset, or be used to create your own.
#' @format a \code{data.frame} containing new and legacy ID, name, …
#' @author Fenhl
#' @source Wurstmineberg; see \url{http://assets.wurstmineberg.de}
#' and \url{https://github.com/wurstmineberg/assets.wurstmineberg.de}
"strings.items"
#' @name strings.achievements
#' @title Strings for item stats
#' @description A set of substitutable strings for achievement data.
#' @docType data
#' @keywords datasets
#' @usage strings.achievements
#' @note \code{\link[wurstmineR]{getStrings}} can be used to update this dataset, or be used to create your own.
#' @format a \code{data.frame} containing new and legacy ID, name, …
#' @author Farthen, Fenhl
#' @source Wurstmineberg; see \url{http://assets.wurstmineberg.de}
#' and \url{https://github.com/wurstmineberg/assets.wurstmineberg.de}
"strings.achievements"
#' @name strings.mobs
#' @title Strings for mob names
#' @description A set of substitutable strings for mob names, 
#' for cases where the ingame ID varies from the commonly used name.
#' @docType data
#' @keywords datasets
#' @usage strings.mobs
#' @note \code{\link[wurstmineR]{getStrings}} can be used to update this dataset, or be used to create your own.
#' @format a \code{data.frame} containing name and id.
#' @author Jemus42
#' @source Wurstmineberg; see \url{http://assets.wurstmineberg.de} 
#' and \url{https://github.com/wurstmineberg/assets.wurstmineberg.de}
"strings.mobs"
#' @name strings.biomes
#' @title Strings for biomes
#' @description A set of substitutable strings for biomes names, 
#' @docType data
#' @keywords datasets
#' @usage strings.biomes
#' @note \code{\link[wurstmineR]{getStrings}} can be used to update this dataset, or be used to create your own.
#' @format a \code{data.frame} containing "adventuringTime", "description", "id", "type", "name"
#' @author Farthen, Fenhl
#' @source Wurstmineberg; see \url{http://assets.wurstmineberg.de}
#' and \url{https://github.com/wurstmineberg/assets.wurstmineberg.de}
"strings.biomes"
jemus42/wurstmineR documentation built on May 19, 2019, 4:03 a.m.