HOOK_UPDATING_SIGN


Index:
Articles
Classes
Hooks

Quick navigation:
BLOCK_SPREAD
BLOCK_TO_PICKUPS
BREWING_COMPLETED
BREWING_COMPLETING
CHAT
CHUNK_AVAILABLE
CHUNK_GENERATED
CHUNK_GENERATING
CHUNK_UNLOADED
CHUNK_UNLOADING
COLLECTING_PICKUP
CRAFTING_NO_RECIPE
DISCONNECT
DROPSPENSE
ENTITY_ADD_EFFECT
ENTITY_CHANGED_WORLD
ENTITY_CHANGING_WORLD
ENTITY_TELEPORT
EXECUTE_COMMAND
EXPLODED
EXPLODING
HANDSHAKE
HOPPER_PULLING_ITEM
HOPPER_PUSHING_ITEM
KILLED
KILLING
LOGIN
LOGIN_FORGE
PLAYER_ANIMATION
PLAYER_BREAKING_BLOCK
PLAYER_BROKEN_BLOCK
PLAYER_CROUCHED
PLAYER_DESTROYED
PLAYER_EATING
PLAYER_FISHED
PLAYER_FISHING
PLAYER_FOOD_LEVEL_CHANGE
PLAYER_JOINED
PLAYER_LEFT_CLICK
PLAYER_MOVING
PLAYER_OPENING_WINDOW
PLAYER_PLACED_BLOCK
PLAYER_PLACING_BLOCK
PLAYER_RIGHT_CLICK
PLAYER_RIGHT_CLICKING_ENTITY
PLAYER_SHOOTING
PLAYER_SPAWNED
PLAYER_TOSSING_ITEM
PLAYER_USED_BLOCK
PLAYER_USED_ITEM
PLAYER_USING_BLOCK
PLAYER_USING_ITEM
PLUGINS_LOADED
PLUGIN_MESSAGE
POST_CRAFTING
PRE_CRAFTING
PROJECTILE_HIT_BLOCK
PROJECTILE_HIT_ENTITY
SERVER_PING
SPAWNED_ENTITY
SPAWNED_MONSTER
SPAWNING_ENTITY
SPAWNING_MONSTER
TAKE_DAMAGE
TICK
UPDATED_SIGN
UPDATING_SIGN
WEATHER_CHANGED
WEATHER_CHANGING
WORLD_STARTED
WORLD_TICK

This hook is called when a sign text is about to be updated, either as a result of player's manipulation or any other event, such as a plugin setting the sign text. Plugins may modify the text or refuse the update altogether.

See also the HOOK_UPDATED_SIGN hook for a similar hook called after the update.


Callback function

The default name for the callback function is OnUpdatingSign. It has the following signature:

function MyOnUpdatingSign(World, BlockX, BlockY, BlockZ, Line1, Line2, Line3, Line4, Player)

Parameters:

NameTypeNotes
WorldcWorldThe world in which the sign resides
BlockXnumberX-coord of the sign
BlockYnumberY-coord of the sign
BlockZnumberZ-coord of the sign
Line1string1st line of the new text
Line2string2nd line of the new text
Line3string3rd line of the new text
Line4string4th line of the new text
PlayercPlayerThe player who is changing the text. May be nil for non-player updates.

The function may return up to five values. If the function returns true as the first value, no other callbacks are called for this event and the sign is not updated. If the function returns no value or false as its first value, other plugins' callbacks are called.

The other up to four values returned are used to update the sign text, line by line, respectively. Note that other plugins may again update the texts (if the first value returned is false).


Code examples

Registering the callback

cPluginManager:AddHook(cPluginManager.HOOK_UPDATING_SIGN, MyOnUpdatingSign);

Add player signature

The following example appends a player signature to the last line, if the sign is updated by a player:

function OnUpdatingSign(World, BlockX, BlockY, BlockZ, Line1, Line2, Line3, Line4, Player)
	if (Player == nil) then
		-- Not changed by a player
		return false;
	end

	-- Sign with playername, allow other plugins to interfere:
	return false, Line1, Line2, Line3, Line4 .. Player:GetName();
end
				
Generated by APIDump on 2022-10-28 17:00:47, Build ID Unknown, Commit approx: 21ec3ebe26bff24b5fc6d96f86a441c9c9628247