FrameworkZ API Documentation - FrameworkZ.Tooltips

Home / FrameworkZ.Tooltips Module

FrameworkZ.Tooltips

module

Manage dynamic on-screen tooltips for player characters with scoring and typewriter effects.

3
Functions
19
Methods
2
Fields

📋 On This Page

Fields

2
FrameworkZ.Tooltips 📋 table
Manage dynamic on-screen tooltips for player characters with scoring and typewriter effects.
Initial value: {}
FrameworkZ.Tooltips.HoveredCharacterData ❓ unknown inferred
Initial value: { UI = nil, Texture = getTexture("media/textures/fz-selector.png"), TextureScale = 1.0, TextureAlpha = 0.8, TextureYOffset = 0.25, TooltipShowing = false, TooltipPlayer = nil, TooltipCharacterName = "", TooltipCharacterFaction = "",

Methods

19

FrameworkZ.Tooltips:CalculateCharacterScore(localPlayer, targetPlayer, mouseX, mouseY)

method undocumented
No documentation available

Parameters (inferred)

localPlayer ❓ unknown
Parameter inferred from function signature
targetPlayer ❓ unknown
Parameter inferred from function signature
mouseX ❓ unknown
Parameter inferred from function signature
mouseY ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Tooltips:CalculateLineOfSight(localPlayer, targetPlayer, restrictive, adjacentRange)

method undocumented
No documentation available

Parameters (inferred)

localPlayer ❓ unknown
Parameter inferred from function signature
targetPlayer ❓ unknown
Parameter inferred from function signature
restrictive ❓ unknown
Parameter inferred from function signature
adjacentRange ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Tooltips:CalculatePlayerTargetAngle(player, targetX, targetY)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
targetX ❓ unknown
Parameter inferred from function signature
targetY ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Tooltips:CalculateTypewriterSpeed(localPlayer, targetPlayer)

method undocumented
No documentation available

Parameters (inferred)

localPlayer ❓ unknown
Parameter inferred from function signature
targetPlayer ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Tooltips:CheckAdjacentOpening(localSquare, targetSquare, dx, dy, restrictive)

method undocumented
No documentation available

Parameters (inferred)

localSquare ❓ unknown
Parameter inferred from function signature
targetSquare ❓ unknown
Parameter inferred from function signature
dx ❓ unknown
Parameter inferred from function signature
dy ❓ unknown
Parameter inferred from function signature
restrictive ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Tooltips:CheckSquareObstructions(square, stepX, stepY, isTargetSquare, restrictive)

method undocumented
No documentation available

Parameters (inferred)

square ❓ unknown
Parameter inferred from function signature
stepX ❓ unknown
Parameter inferred from function signature
stepY ❓ unknown
Parameter inferred from function signature
isTargetSquare ❓ unknown
Parameter inferred from function signature
restrictive ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Tooltips:CheckWallPassage(door, window, wall, restrictive)

method undocumented
No documentation available

Parameters (inferred)

door ❓ unknown
Parameter inferred from function signature
window ❓ unknown
Parameter inferred from function signature
wall ❓ unknown
Parameter inferred from function signature
restrictive ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Tooltips:CleanupCaches()

method undocumented
No documentation available

FrameworkZ.Tooltips:DisableTooltip()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Tooltips:DoorHasWindow(door)

method undocumented
No documentation available

Parameters (inferred)

door ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Tooltips:EnableTooltip()

method undocumented
No documentation available

FrameworkZ.Tooltips:GetDescriptionLines(desc)

method undocumented
No documentation available

Parameters (inferred)

desc ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Tooltips:GetDirectionVector(isoDirection)

method undocumented
No documentation available

Parameters (inferred)

isoDirection ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Tooltips:HasLineOfSight(localPlayer, targetPlayer)

method undocumented
No documentation available

Parameters (inferred)

localPlayer ❓ unknown
Parameter inferred from function signature
targetPlayer ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Tooltips:HasLineOfSightForTypewriter(localPlayer, targetPlayer)

method undocumented
No documentation available

Parameters (inferred)

localPlayer ❓ unknown
Parameter inferred from function signature
targetPlayer ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Tooltips:IsPlayerFacingTarget(player, targetX, targetY, fieldOfViewAngle)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
targetX ❓ unknown
Parameter inferred from function signature
targetY ❓ unknown
Parameter inferred from function signature
fieldOfViewAngle ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Tooltips:OnReceiveCharacterData(responseData)

method undocumented
No documentation available

Parameters (inferred)

responseData ❓ unknown
Parameter inferred from function signature

FrameworkZ.Tooltips:ResetTypewriterState()

method undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Tooltips:UpdateTypewriterProgress()

method undocumented
No documentation available

Functions

3

FrameworkZ.Tooltips.DrawTooltip()

function undocumented
No documentation available

FrameworkZ.Tooltips.OnTick()

function undocumented
No documentation available

FrameworkZ.Tooltips.RequestCharacterData(data, localUsername, targetUsername, requestingPlayer)

function undocumented
No documentation available

Parameters (inferred)

data ❓ unknown
Parameter inferred from function signature
localUsername ❓ unknown
Parameter inferred from function signature
targetUsername ❓ unknown
Parameter inferred from function signature
requestingPlayer ❓ unknown
Parameter inferred from function signature