mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
568 lines
26 KiB
HTML
568 lines
26 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class MapUtil
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class MapUtil
|
|
">
|
|
<meta name="generator" content="docfx 2.59.4.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Dalamud.Utility.MapUtil">
|
|
|
|
|
|
<h1 id="Dalamud_Utility_MapUtil" data-uid="Dalamud.Utility.MapUtil" class="text-break">Class MapUtil
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Utility helper class for game maps and coordinate translations that don't require state.</p>
|
|
<p>The conversion methods were found in 89 54 24 10 56 41 55 41 56 48 81 EC, which itself was found by looking for
|
|
uses of AddonText 1631.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><span class="xref">MapUtil</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetHashCode()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.MemberwiseClone()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ToString()</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Utility.html">Dalamud.Utility</a></h6>
|
|
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
|
|
<h5 id="Dalamud_Utility_MapUtil_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static class MapUtil</code></pre>
|
|
</div>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_MapUtil_ConvertWorldCoordXZToMapCoord_System_Single_System_UInt32_System_Int32_.md&value=---%0Auid%3A%20Dalamud.Utility.MapUtil.ConvertWorldCoordXZToMapCoord(System.Single%2CSystem.UInt32%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Utility/MapUtil.cs/#L23">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Utility_MapUtil_ConvertWorldCoordXZToMapCoord_" data-uid="Dalamud.Utility.MapUtil.ConvertWorldCoordXZToMapCoord*"></a>
|
|
<h4 id="Dalamud_Utility_MapUtil_ConvertWorldCoordXZToMapCoord_System_Single_System_UInt32_System_Int32_" data-uid="Dalamud.Utility.MapUtil.ConvertWorldCoordXZToMapCoord(System.Single,System.UInt32,System.Int32)">ConvertWorldCoordXZToMapCoord(Single, UInt32, Int32)</h4>
|
|
<div class="markdown level1 summary"><p>Helper method to convert one of the game's Vector3 X/Z provided by the game to a map coordinate suitable for
|
|
display to the player.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static float ConvertWorldCoordXZToMapCoord(float value, uint scale, int offset)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The raw float of a game Vector3 X or Z coordinate to convert.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.UInt32</span></td>
|
|
<td><span class="parametername">scale</span></td>
|
|
<td><p>The scale factor of the map, generally retrieved from Lumina.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">offset</span></td>
|
|
<td><p>The dimension offset for either X or Z, generally retrieved from Lumina.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><p>Returns a converted float for display to the player.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_MapUtil_ConvertWorldCoordYToMapCoord_System_Single_System_Int32_System_Boolean_.md&value=---%0Auid%3A%20Dalamud.Utility.MapUtil.ConvertWorldCoordYToMapCoord(System.Single%2CSystem.Int32%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Utility/MapUtil.cs/#L38">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Utility_MapUtil_ConvertWorldCoordYToMapCoord_" data-uid="Dalamud.Utility.MapUtil.ConvertWorldCoordYToMapCoord*"></a>
|
|
<h4 id="Dalamud_Utility_MapUtil_ConvertWorldCoordYToMapCoord_System_Single_System_Int32_System_Boolean_" data-uid="Dalamud.Utility.MapUtil.ConvertWorldCoordYToMapCoord(System.Single,System.Int32,System.Boolean)">ConvertWorldCoordYToMapCoord(Single, Int32, Boolean)</h4>
|
|
<div class="markdown level1 summary"><p>Helper method to convert a game Vector3 Y coordinate to a map coordinate suitable for display to the player.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static float ConvertWorldCoordYToMapCoord(float value, int zOffset, bool correctZOffset = false)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The raw float of a game Vector3 Y coordinate to convert.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">zOffset</span></td>
|
|
<td><p>The zOffset for this map. Retrieved from TerritoryTypeTransient.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><span class="parametername">correctZOffset</span></td>
|
|
<td><p>Optionally enable Z offset correction. When a Z offset of -10,000 is set, replace
|
|
it with 0 for calculation purposes to show a more sane Z coordinate.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><p>Returns a converted float for display to the player.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_MapUtil_WorldToMap_System_Numerics_Vector2_Lumina_Excel_GeneratedSheets_Map_.md&value=---%0Auid%3A%20Dalamud.Utility.MapUtil.WorldToMap(System.Numerics.Vector2%2CLumina.Excel.GeneratedSheets.Map)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Utility/MapUtil.cs/#L127">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Utility_MapUtil_WorldToMap_" data-uid="Dalamud.Utility.MapUtil.WorldToMap*"></a>
|
|
<h4 id="Dalamud_Utility_MapUtil_WorldToMap_System_Numerics_Vector2_Lumina_Excel_GeneratedSheets_Map_" data-uid="Dalamud.Utility.MapUtil.WorldToMap(System.Numerics.Vector2,Lumina.Excel.GeneratedSheets.Map)">WorldToMap(Vector2, Map)</h4>
|
|
<div class="markdown level1 summary"><p>All-in-one helper method to convert a World Coordinate (internal to the game) to a Map Coordinate (visible to
|
|
players in the minimap/elsewhere).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Vector2 WorldToMap(Vector2 worldCoordinates, Map map)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Numerics.Vector2</span></td>
|
|
<td><span class="parametername">worldCoordinates</span></td>
|
|
<td><p>A Vector2 of raw World coordinates from the game.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">Lumina.Excel.GeneratedSheets.Map</span></td>
|
|
<td><span class="parametername">map</span></td>
|
|
<td><p>A Lumina map to use for offset/scale information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Numerics.Vector2</span></td>
|
|
<td><p>Returns a Vector2 representing visible map coordinates.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_MapUtil_WorldToMap_System_Numerics_Vector2_System_Int32_System_Int32_System_UInt32_.md&value=---%0Auid%3A%20Dalamud.Utility.MapUtil.WorldToMap(System.Numerics.Vector2%2CSystem.Int32%2CSystem.Int32%2CSystem.UInt32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Utility/MapUtil.cs/#L109">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Utility_MapUtil_WorldToMap_" data-uid="Dalamud.Utility.MapUtil.WorldToMap*"></a>
|
|
<h4 id="Dalamud_Utility_MapUtil_WorldToMap_System_Numerics_Vector2_System_Int32_System_Int32_System_UInt32_" data-uid="Dalamud.Utility.MapUtil.WorldToMap(System.Numerics.Vector2,System.Int32,System.Int32,System.UInt32)">WorldToMap(Vector2, Int32, Int32, UInt32)</h4>
|
|
<div class="markdown level1 summary"><p>All-in-one helper method to convert a World Coordinate (internal to the game) to a Map Coordinate (visible to
|
|
players in the minimap/elsewhere).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Vector2 WorldToMap(Vector2 worldCoordinates, int xOffset = 0, int yOffset = 0, uint scale = 100U)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Numerics.Vector2</span></td>
|
|
<td><span class="parametername">worldCoordinates</span></td>
|
|
<td><p>A Vector2 of raw World coordinates from the game.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">xOffset</span></td>
|
|
<td><p>The offset to apply to the incoming X parameter, generally Lumina's Map.OffsetX.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">yOffset</span></td>
|
|
<td><p>The offset to apply to the incoming Y parameter, generally Lumina's Map.OffsetY.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.UInt32</span></td>
|
|
<td><span class="parametername">scale</span></td>
|
|
<td><p>The global scale to apply to the incoming X and Y parameters, generally Lumina's Map.SizeFactor.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Numerics.Vector2</span></td>
|
|
<td><p>Returns a Vector2 representing visible map coordinates.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_MapUtil_WorldToMap_System_Numerics_Vector3_Lumina_Excel_GeneratedSheets_Map_Lumina_Excel_GeneratedSheets_TerritoryTypeTransient_System_Boolean_.md&value=---%0Auid%3A%20Dalamud.Utility.MapUtil.WorldToMap(System.Numerics.Vector3%2CLumina.Excel.GeneratedSheets.Map%2CLumina.Excel.GeneratedSheets.TerritoryTypeTransient%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Utility/MapUtil.cs/#L88">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Utility_MapUtil_WorldToMap_" data-uid="Dalamud.Utility.MapUtil.WorldToMap*"></a>
|
|
<h4 id="Dalamud_Utility_MapUtil_WorldToMap_System_Numerics_Vector3_Lumina_Excel_GeneratedSheets_Map_Lumina_Excel_GeneratedSheets_TerritoryTypeTransient_System_Boolean_" data-uid="Dalamud.Utility.MapUtil.WorldToMap(System.Numerics.Vector3,Lumina.Excel.GeneratedSheets.Map,Lumina.Excel.GeneratedSheets.TerritoryTypeTransient,System.Boolean)">WorldToMap(Vector3, Map, TerritoryTypeTransient, Boolean)</h4>
|
|
<div class="markdown level1 summary"><p>All-in-one helper method to convert a World Coordinate (internal to the game) to a Map Coordinate (visible to
|
|
players in the minimap/elsewhere).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Vector3 WorldToMap(Vector3 worldCoordinates, Map map, TerritoryTypeTransient territoryTransient, bool correctZOffset = false)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Numerics.Vector3</span></td>
|
|
<td><span class="parametername">worldCoordinates</span></td>
|
|
<td><p>A Vector3 of raw World coordinates from the game.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">Lumina.Excel.GeneratedSheets.Map</span></td>
|
|
<td><span class="parametername">map</span></td>
|
|
<td><p>A Lumina map to use for offset/scale information.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">Lumina.Excel.GeneratedSheets.TerritoryTypeTransient</span></td>
|
|
<td><span class="parametername">territoryTransient</span></td>
|
|
<td><p>A TerritoryTypeTransient to use for Z offset information.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><span class="parametername">correctZOffset</span></td>
|
|
<td><p>An optional mode to "correct" a Z offset of -10000 to be a more human-friendly value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Numerics.Vector3</span></td>
|
|
<td><p>Returns a Vector3 representing visible map coordinates.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Dalamud_Utility_MapUtil_WorldToMap_System_Numerics_Vector3_Lumina_Excel_GeneratedSheets_Map_Lumina_Excel_GeneratedSheets_TerritoryTypeTransient_System_Boolean__remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>Note that this method will swap Y and Z to appropriately reflect the game's display.</p>
|
|
</div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_MapUtil_WorldToMap_System_Numerics_Vector3_System_Int32_System_Int32_System_Int32_System_UInt32_System_Boolean_.md&value=---%0Auid%3A%20Dalamud.Utility.MapUtil.WorldToMap(System.Numerics.Vector3%2CSystem.Int32%2CSystem.Int32%2CSystem.Int32%2CSystem.UInt32%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Utility/MapUtil.cs/#L62">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Utility_MapUtil_WorldToMap_" data-uid="Dalamud.Utility.MapUtil.WorldToMap*"></a>
|
|
<h4 id="Dalamud_Utility_MapUtil_WorldToMap_System_Numerics_Vector3_System_Int32_System_Int32_System_Int32_System_UInt32_System_Boolean_" data-uid="Dalamud.Utility.MapUtil.WorldToMap(System.Numerics.Vector3,System.Int32,System.Int32,System.Int32,System.UInt32,System.Boolean)">WorldToMap(Vector3, Int32, Int32, Int32, UInt32, Boolean)</h4>
|
|
<div class="markdown level1 summary"><p>All-in-one helper method to convert a World Coordinate (internal to the game) to a Map Coordinate (visible to
|
|
players in the minimap/elsewhere).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Vector3 WorldToMap(Vector3 worldCoordinates, int xOffset = 0, int yOffset = 0, int zOffset = 0, uint scale = 100U, bool correctZOffset = false)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Numerics.Vector3</span></td>
|
|
<td><span class="parametername">worldCoordinates</span></td>
|
|
<td><p>A Vector3 of raw World coordinates from the game.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">xOffset</span></td>
|
|
<td><p>The offset to apply to the incoming X parameter, generally Lumina's Map.OffsetX.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">yOffset</span></td>
|
|
<td><p>The offset to apply to the incoming Y parameter, generally Lumina's Map.OffsetY.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">zOffset</span></td>
|
|
<td><p>The offset to apply to the incoming Z parameter, generally Lumina's TerritoryTypeTransient.OffsetZ.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.UInt32</span></td>
|
|
<td><span class="parametername">scale</span></td>
|
|
<td><p>The global scale to apply to the incoming X and Y parameters, generally Lumina's Map.SizeFactor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><span class="parametername">correctZOffset</span></td>
|
|
<td><p>An optional mode to "correct" a Z offset of -10000 to be a more human-friendly value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Numerics.Vector3</span></td>
|
|
<td><p>Returns a Vector3 representing visible map coordinates.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Dalamud_Utility_MapUtil_WorldToMap_System_Numerics_Vector3_System_Int32_System_Int32_System_Int32_System_UInt32_System_Boolean__remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>Note that this method will swap Y and Z in the resulting Vector3 to appropriately reflect the game's display.</p>
|
|
</div>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
<li>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Utility_MapUtil.md&value=---%0Auid%3A%20Dalamud.Utility.MapUtil%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
|
|
</li>
|
|
<li>
|
|
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Utility/MapUtil.cs/#L13" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<h5>In This Article</h5>
|
|
<div></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|