mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 10:17:22 +01:00
350 lines
18 KiB
HTML
350 lines
18 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 BattleNpc
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class BattleNpc
|
|
">
|
|
<meta name="generator" content="docfx 2.58.9.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.Game.ClientState.Objects.Types.BattleNpc">
|
|
|
|
|
|
<h1 id="Dalamud_Game_ClientState_Objects_Types_BattleNpc" data-uid="Dalamud.Game.ClientState.Objects.Types.BattleNpc" class="text-break">Class BattleNpc
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>This class represents a battle NPC.</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"><a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html">GameObject</a></div>
|
|
<div class="level2"><a class="xref" href="Dalamud.Game.ClientState.Objects.Types.Character.html">Character</a></div>
|
|
<div class="level3"><a class="xref" href="Dalamud.Game.ClientState.Objects.Types.BattleChara.html">BattleChara</a></div>
|
|
<div class="level4"><span class="xref">BattleNpc</span></div>
|
|
</div>
|
|
<div classs="implements">
|
|
<h5>Implements</h5>
|
|
<div><span class="xref">System.IEquatable</span><<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html">GameObject</a>></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.BattleChara.html#Dalamud_Game_ClientState_Objects_Types_BattleChara_StatusList">BattleChara.StatusList</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.BattleChara.html#Dalamud_Game_ClientState_Objects_Types_BattleChara_IsCasting">BattleChara.IsCasting</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.BattleChara.html#Dalamud_Game_ClientState_Objects_Types_BattleChara_IsCastInterruptible">BattleChara.IsCastInterruptible</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.BattleChara.html#Dalamud_Game_ClientState_Objects_Types_BattleChara_CastActionType">BattleChara.CastActionType</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.BattleChara.html#Dalamud_Game_ClientState_Objects_Types_BattleChara_CastActionId">BattleChara.CastActionId</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.BattleChara.html#Dalamud_Game_ClientState_Objects_Types_BattleChara_CastTargetObjectId">BattleChara.CastTargetObjectId</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.BattleChara.html#Dalamud_Game_ClientState_Objects_Types_BattleChara_CurrentCastTime">BattleChara.CurrentCastTime</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.BattleChara.html#Dalamud_Game_ClientState_Objects_Types_BattleChara_TotalCastTime">BattleChara.TotalCastTime</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.Character.html#Dalamud_Game_ClientState_Objects_Types_Character_CurrentHp">Character.CurrentHp</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.Character.html#Dalamud_Game_ClientState_Objects_Types_Character_MaxHp">Character.MaxHp</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.Character.html#Dalamud_Game_ClientState_Objects_Types_Character_CurrentMp">Character.CurrentMp</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.Character.html#Dalamud_Game_ClientState_Objects_Types_Character_MaxMp">Character.MaxMp</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.Character.html#Dalamud_Game_ClientState_Objects_Types_Character_CurrentGp">Character.CurrentGp</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.Character.html#Dalamud_Game_ClientState_Objects_Types_Character_MaxGp">Character.MaxGp</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.Character.html#Dalamud_Game_ClientState_Objects_Types_Character_CurrentCp">Character.CurrentCp</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.Character.html#Dalamud_Game_ClientState_Objects_Types_Character_MaxCp">Character.MaxCp</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.Character.html#Dalamud_Game_ClientState_Objects_Types_Character_ClassJob">Character.ClassJob</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.Character.html#Dalamud_Game_ClientState_Objects_Types_Character_Level">Character.Level</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.Character.html#Dalamud_Game_ClientState_Objects_Types_Character_Customize">Character.Customize</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.Character.html#Dalamud_Game_ClientState_Objects_Types_Character_CompanyTag">Character.CompanyTag</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.Character.html#Dalamud_Game_ClientState_Objects_Types_Character_NameId">Character.NameId</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.Character.html#Dalamud_Game_ClientState_Objects_Types_Character_StatusFlags">Character.StatusFlags</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_InvalidGameObjectId">GameObject.InvalidGameObjectId</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_Address">GameObject.Address</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_IsValid_Dalamud_Game_ClientState_Objects_Types_GameObject_">GameObject.IsValid(GameObject)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_IsValid">GameObject.IsValid()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_System_IEquatable_Dalamud_Game_ClientState_Objects_Types_GameObject__Equals_Dalamud_Game_ClientState_Objects_Types_GameObject_">GameObject.IEquatable<GameObject>.Equals(GameObject)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_Equals_System_Object_">GameObject.Equals(Object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_GetHashCode">GameObject.GetHashCode()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_Name">GameObject.Name</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_ObjectId">GameObject.ObjectId</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_DataId">GameObject.DataId</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_OwnerId">GameObject.OwnerId</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_ObjectKind">GameObject.ObjectKind</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_SubKind">GameObject.SubKind</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_YalmDistanceX">GameObject.YalmDistanceX</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_YalmDistanceZ">GameObject.YalmDistanceZ</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_Position">GameObject.Position</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_Rotation">GameObject.Rotation</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_HitboxRadius">GameObject.HitboxRadius</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_TargetObject">GameObject.TargetObject</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_ToString">GameObject.ToString()</a>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</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>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Game.ClientState.Objects.Types.html">Dalamud.Game.ClientState.Objects.Types</a></h6>
|
|
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
|
|
<h5 id="Dalamud_Game_ClientState_Objects_Types_BattleNpc_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class BattleNpc : BattleChara, IEquatable<GameObject></code></pre>
|
|
</div>
|
|
<h3 id="properties">Properties
|
|
</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_Game_ClientState_Objects_Types_BattleNpc_BattleNpcKind.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.BattleNpc.BattleNpcKind%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/Game/ClientState/Objects/SubKinds/BattleNpc.cs/#L25">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_BattleNpc_BattleNpcKind_" data-uid="Dalamud.Game.ClientState.Objects.Types.BattleNpc.BattleNpcKind*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_BattleNpc_BattleNpcKind" data-uid="Dalamud.Game.ClientState.Objects.Types.BattleNpc.BattleNpcKind">BattleNpcKind</h4>
|
|
<div class="markdown level1 summary"><p>Gets the BattleNpc <a class="xref" href="Dalamud.Game.ClientState.Objects.Enums.BattleNpcSubKind.html">BattleNpcSubKind</a> of this BattleNpc.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public BattleNpcSubKind BattleNpcKind { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Game.ClientState.Objects.Enums.BattleNpcSubKind.html">BattleNpcSubKind</a></td>
|
|
<td></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_Game_ClientState_Objects_Types_BattleNpc_TargetObjectId.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.BattleNpc.TargetObjectId%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/Game/ClientState/Objects/SubKinds/BattleNpc.cs/#L28">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_BattleNpc_TargetObjectId_" data-uid="Dalamud.Game.ClientState.Objects.Types.BattleNpc.TargetObjectId*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_BattleNpc_TargetObjectId" data-uid="Dalamud.Game.ClientState.Objects.Types.BattleNpc.TargetObjectId">TargetObjectId</h4>
|
|
<div class="markdown level1 summary"><p>Gets the target object ID of the character.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override uint TargetObjectId { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</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.UInt32</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="Dalamud.Game.ClientState.Objects.Types.Character.html#Dalamud_Game_ClientState_Objects_Types_Character_TargetObjectId">Character.TargetObjectId</a></div>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<span class="xref">System.IEquatable<T></span>
|
|
</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_Game_ClientState_Objects_Types_BattleNpc.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.BattleNpc%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/Game/ClientState/Objects/SubKinds/BattleNpc.cs/#L10" 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>
|