Module:LibraryUtil：修订间差异

2023年11月19日 (日) 02:53的版本

Module documentation[view][edit][history][purge]

This documentation is transcluded from Module:LibraryUtil/doc. Changes can be proposed in the talk page.

Module:LibraryUtil is mostly to keep track of modules using the standard Scributo library libraryUtil. See Module:LibraryUtil on RuneScape Wiki for more details.

-- Imported from: https://runescape.wiki/w/Module:LibraryUtil

-- <nowiki>
local libraryUtil = require( 'libraryUtil' )

function libraryUtil.makeCheckClassFunction( libraryName, varName, class, selfObjDesc )
	return function ( self, method )
		if getmetatable( self ) ~= class then
			error( string.format(
				"%s: invalid %s. Did you call %s with a dot instead of a colon, i.e. " ..
				"%s.%s() instead of %s:%s()?",
				libraryName, selfObjDesc, method, varName, method, varName, method
			), 3 )
		end
	end
end

return libraryUtil
-- </nowiki>

@@ 第1行： / 第1行： @@
+-- Imported from: https://runescape.wiki/w/Module:LibraryUtil
 -- <nowiki>
 local libraryUtil = require( 'libraryUtil' )
--- libraryUtil is a standard scribunto module, the following commented out code is just to show what is inside it. Documentation about these functions can be found at https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#libraryUtil
---[=[
-local libraryUtil = {}
-function libraryUtil.checkType( name, argIdx, arg, expectType, nilOk )
- if arg == nil and nilOk then
- return
- end
- if type( arg ) ~= expectType then
- local msg = string.format( "bad argument #%d to '%s' (%s expected, got %s)",
- argIdx, name, expectType, type( arg )
- )
- error( msg, 3 )
- end
-end
-function libraryUtil.checkTypeMulti( name, argIdx, arg, expectTypes )
- local argType = type( arg )
- for _, expectType in ipairs( expectTypes ) do
- if argType == expectType then
- return
- end
- end
- local n = #expectTypes
- local typeList
- if n > 1 then
- typeList = table.concat( expectTypes, ', ', 1, n - 1 ) .. ' or ' .. expectTypes[n]
- else
- typeList = expectTypes[1]
- end
- local msg = string.format( "bad argument #%d to '%s' (%s expected, got %s)",
- argIdx,
- name,
- typeList,
- type( arg )
- )
- error( msg, 3 )
-end
-function libraryUtil.checkTypeForIndex( index, value, expectType )
- if type( value ) ~= expectType then
- local msg = string.format( "value for index '%s' must be %s, %s given",
- index, expectType, type( value )
- )
- error( msg, 3 )
- end
-end
-function libraryUtil.checkTypeForNamedArg( name, argName, arg, expectType, nilOk )
- if arg == nil and nilOk then
- return
- end
- if type( arg ) ~= expectType then
- local msg = string.format( "bad named argument %s to '%s' (%s expected, got %s)",
- argName, name, expectType, type( arg )
- )
- error( msg, 3 )
- end
-end
-function libraryUtil.makeCheckSelfFunction( libraryName, varName, selfObj, selfObjDesc )
- return function ( self, method )
- if self ~= selfObj then
- error( string.format(
- "%s: invalid %s. Did you call %s with a dot instead of a colon, i.e. " ..
- "%s.%s() instead of %s:%s()?",
- libraryName, selfObjDesc, method, varName, method, varName, method
- ), 3 )
- end
- end
-end
-]=]
 function libraryUtil.makeCheckClassFunction( libraryName, varName, class, selfObjDesc )