Jump to content

Docs: Difference between revisions

← Older editNewer edit →
VisualWikitext
Poopman (talk | contribs)
editor
40 edits
No edit summary
Poopman (talk | contribs)
editor
40 edits
No edit summary
Line 11: Line 11:
!Listen Event
!Listen Event
!Functions Fired
!Functions Fired
!Description
!Example Usage
!Example Usage
!Related Code
!Related Code
Line 18: Line 17:
|load
|load
|w.emit("clientLoaded");
|w.emit("clientLoaded");
|When the window is loaded, the client emits a "client loaded" event. This is currently not utilized.
|
|
|<syntaxhighlight lang="javascript" line="1" start="187">
|<syntaxhighlight lang="javascript" line="1" start="187">
Line 29: Line 27:
|hash change
|hash change
|manageCoordHash();
|manageCoordHash();
|The URL hash is parsed and if it contains x,y coords then it will teleport the user to that location so long as the World and User models allow it.
|https://ourworldoftext.com/#x:10,y:20
|https://ourworldoftext.com/#x:10,y:20
|<syntaxhighlight lang="javascript" line="1" start="5639">
|<syntaxhighlight lang="javascript" line="1" start="5639">
Line 40: Line 37:
|before unload
|before unload
|if(writeBuffer.length) flushWrites();
|if(writeBuffer.length) flushWrites();
|Sends remaining edits to the server before leaving the page.
|
|
|<syntaxhighlight lang="javascript" line="1" start="5643">
|<syntaxhighlight lang="javascript" line="1" start="5643">
Line 51: Line 47:
|resize
|resize
|event_resize
|event_resize
|Adjusts the scaling and calcuated ratio, then re-renders the canvas.
|
|
|<syntaxhighlight lang="javascript" line="1" start="1192">
|<syntaxhighlight lang="javascript" line="1" start="1192">
Line 60: Line 55:
|select start
|select start
|self
|self
|Checks if the event is happening on a modal, canvas, or chat window.
|
|
|<syntaxhighlight lang="javascript" line="1" start="5647">
|<syntaxhighlight lang="javascript" line="1" start="5647">
Line 79: Line 73:
* event_keydown_copy_color
* event_keydown_copy_color
* event_keydown
* event_keydown
|
* Determines if regionSelect function should start.
* Determines if the user is trying to copy a character at the cursor or mouse position.
* Determines if the user is trying to copy  a color or background color at the mouse position.
* Handles keydown events for zooming, arrows, erasing, tabbing, esc, and typing.
|
|
|<syntaxhighlight lang="javascript" line="1" start="525">
|<syntaxhighlight lang="javascript" line="1" start="525">
Line 98: Line 87:
|key up
|key up
|event_keyup
|event_keyup
|Emits a "keyUp" event whenever a key is released.
|
|
|<syntaxhighlight lang="javascript" line="1" start="2957">
|<syntaxhighlight lang="javascript" line="1" start="2957">
Line 112: Line 100:
* mousemove_linkAuto
* mousemove_linkAuto
* event_mousemove
* event_mousemove
|
* If tileProtectAuto is active, the tile or cell gets protected on mouse move.
* If linkAuto is active, the cell gets a link on mouse move.
* handles region selection, coord-linking, protection, and dragging.
|
|
|<syntaxhighlight lang="javascript" line="1" start="945">
|<syntaxhighlight lang="javascript" line="1" start="945">
Line 128: Line 112:
|mouse down
|mouse down
|event_mousedown
|event_mousedown
|Handles dragging, ,setting currentMousePosition, and emits "mouseDown" event.
|
|
|<syntaxhighlight lang="javascript" line="1">
|<syntaxhighlight lang="javascript" line="1" start="1771">
/
document.addEventListener("mousedown", event_mousedown);
</syntaxhighlight>
</syntaxhighlight>
|-
|-
Line 137: Line 120:
|mouse up
|mouse up
|event_mouseup
|event_mouseup
|Stops any dragging, region selection, emits a "mouseUp" event and changes cursor position.
|
|
|
|<syntaxhighlight lang="javascript" line="1" start="1947">
document.addEventListener("mouseup", event_mouseup);
</syntaxhighlight>
|-
|-
|
|
Line 145: Line 129:
|event_mouseenter
|event_mouseenter
|
|
|
|<syntaxhighlight lang="javascript" line="1" start="1958">
|<syntaxhighlight lang="javascript" line="1">
document.addEventListener("mouseenter", event_mouseenter);
/
</syntaxhighlight>
</syntaxhighlight>
|-
|-
Line 154: Line 137:
|event_touchstart
|event_touchstart
|
|
|
|<syntaxhighlight lang="javascript" line="1" start="3452">
|<syntaxhighlight lang="javascript" line="1">
document.addEventListener("touchstart", event_touchstart);
/
</syntaxhighlight>
</syntaxhighlight>
|-
|-
Line 163: Line 145:
|event_touchend
|event_touchend
|
|
|
|<syntaxhighlight lang="javascript" line="1" start="3453">
|<syntaxhighlight lang="javascript" line="1">
document.addEventListener("touchend", event_touchend);
/
</syntaxhighlight>
</syntaxhighlight>
|-
|-
Line 172: Line 153:
|event_touchmove
|event_touchmove
|
|
|
|<syntaxhighlight lang="javascript" line="1" start="3454">
|<syntaxhighlight lang="javascript" line="1">
document.addEventListener("touchmove", event_touchmove, { passive: false });
/
</syntaxhighlight>
</syntaxhighlight>
|-
|-
Line 183: Line 163:
* event_wheel_zoom
* event_wheel_zoom
|
|
|
|<syntaxhighlight lang="javascript" line="1" start="3487">
|<syntaxhighlight lang="javascript" line="1">
document.addEventListener("wheel", event_wheel);
/
</syntaxhighlight><syntaxhighlight lang="javascript" line="1" start="3537">
document.addEventListener("wheel", event_wheel_zoom, {
passive: false
});
</syntaxhighlight>
</syntaxhighlight>
|-
|-
Line 194: Line 177:
* keydown_linkAuto
* keydown_linkAuto
|
|
|
|<syntaxhighlight lang="javascript" line="1" start="1012">
|<syntaxhighlight lang="javascript" line="1">
document.body.addEventListener("keydown", keydown_tileProtectAuto);
/
</syntaxhighlight><syntaxhighlight lang="javascript" line="1" start="1138">
document.body.addEventListener("keydown", keydown_linkAuto);
</syntaxhighlight>
</syntaxhighlight>
|-
|-
Line 203: Line 187:
|onKeyUp
|onKeyUp
|
|
|
|<syntaxhighlight lang="javascript" line="1" start="1164">
|<syntaxhighlight lang="javascript" line="1">
document.body.addEventListener("keyup", onKeyUp);
/
</syntaxhighlight>
</syntaxhighlight>
|-
|-
Line 212: Line 195:
|updateCoordDisplay
|updateCoordDisplay
|
|
|
|<syntaxhighlight lang="javascript" line="1" start="280">
|<syntaxhighlight lang="javascript" line="1">
w.on("cursorMove", updateCoordDisplay);
/
</syntaxhighlight>
</syntaxhighlight>
|-
|-
Line 221: Line 203:
|updateCoordDisplay
|updateCoordDisplay
|
|
|
|<syntaxhighlight lang="javascript" line="1" start="281">
|<syntaxhighlight lang="javascript" line="1">
w.on("cursorHide", updateCoordDisplay);
/
</syntaxhighlight>
</syntaxhighlight>
|-
|-
Line 229: Line 210:
|tiles Rendered
|tiles Rendered
|self
|self
|
|
|
|<syntaxhighlight lang="javascript" line="1">
|<syntaxhighlight lang="javascript" line="1">
Line 238: Line 218:
|cursor Move
|cursor Move
|setClientGuestCursorPosition
|setClientGuestCursorPosition
|
|
|
|<syntaxhighlight lang="javascript" line="1">
|<syntaxhighlight lang="javascript" line="1">
Line 247: Line 226:
|cursor Hide
|cursor Hide
|setClientGuestCursorPosition
|setClientGuestCursorPosition
|
|
|
|<syntaxhighlight lang="javascript" line="1">
|<syntaxhighlight lang="javascript" line="1">
Line 260: Line 238:
* stabilizeTextInput
* stabilizeTextInput
* event_input
* event_input
|
|
|
|<syntaxhighlight lang="javascript" line="1">
|<syntaxhighlight lang="javascript" line="1">
Line 269: Line 246:
|context menu
|context menu
|self
|self
|
|
|
|<syntaxhighlight lang="javascript" line="1">
|<syntaxhighlight lang="javascript" line="1">
Line 278: Line 254:
|click
|click
|self
|self
|
|
|
|
|
Retrieved from "https://wiki.ourworldoftext.com/wiki/Docs"