mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
1063 lines
54 KiB
HTML
1063 lines
54 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 GameObject
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class GameObject
|
|
">
|
|
<meta name="generator" content="docfx 2.59.0.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.GameObject">
|
|
|
|
|
|
<h1 id="Dalamud_Game_ClientState_Objects_Types_GameObject" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject" class="text-break">Class GameObject
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>This class represents a GameObject in FFXIV.</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">GameObject</span></div>
|
|
<div class="level2"><a class="xref" href="Dalamud.Game.ClientState.Objects.SubKinds.EventObj.html">EventObj</a></div>
|
|
<div class="level2"><a class="xref" href="Dalamud.Game.ClientState.Objects.Types.Character.html">Character</a></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>
|
|
<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_GameObject_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class GameObject : IEquatable<GameObject></code></pre>
|
|
</div>
|
|
<h3 id="fields">Fields
|
|
</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_GameObject_InvalidGameObjectId.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.InvalidGameObjectId%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/Types/GameObject.cs/#L18">View Source</a>
|
|
</span>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_InvalidGameObjectId" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.InvalidGameObjectId">InvalidGameObjectId</h4>
|
|
<div class="markdown level1 summary"><p>IDs of non-networked GameObjects.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public const uint InvalidGameObjectId = 3758096384U</code></pre>
|
|
</div>
|
|
<h5 class="fieldValue">Field 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>
|
|
<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_GameObject_Address.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.Address%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/Types/GameObject.cs/#L32">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_Address_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.Address*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_Address" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.Address">Address</h4>
|
|
<div class="markdown level1 summary"><p>Gets the address of the game object in memory.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IntPtr Address { 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.IntPtr</span></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_GameObject_DataId.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.DataId%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/Types/GameObject.cs/#L109">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_DataId_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.DataId*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_DataId" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.DataId">DataId</h4>
|
|
<div class="markdown level1 summary"><p>Gets the data ID for linking to other respective game data.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public uint DataId { 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>
|
|
<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_GameObject_HitboxRadius.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.HitboxRadius%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/Types/GameObject.cs/#L151">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_HitboxRadius_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.HitboxRadius*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_HitboxRadius" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.HitboxRadius">HitboxRadius</h4>
|
|
<div class="markdown level1 summary"><p>Gets the hitbox radius of this <a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html">GameObject</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public float HitboxRadius { 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.Single</span></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_GameObject_Name.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.Name%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/Types/GameObject.cs/#L99">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_Name_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.Name*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_Name" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.Name">Name</h4>
|
|
<div class="markdown level1 summary"><p>Gets the name of this <a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html">GameObject</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public SeString Name { 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.Text.SeStringHandling.SeString.html">SeString</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_GameObject_ObjectId.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.ObjectId%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/Types/GameObject.cs/#L104">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_ObjectId_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.ObjectId*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_ObjectId" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.ObjectId">ObjectId</h4>
|
|
<div class="markdown level1 summary"><p>Gets the object ID of this <a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html">GameObject</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public uint ObjectId { 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>
|
|
<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_GameObject_ObjectKind.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.ObjectKind%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/Types/GameObject.cs/#L120">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_ObjectKind_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.ObjectKind*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_ObjectKind" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.ObjectKind">ObjectKind</h4>
|
|
<div class="markdown level1 summary"><p>Gets the entity kind of this <a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html">GameObject</a>.
|
|
See <a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html#Dalamud_Game_ClientState_Objects_Types_GameObject_ObjectKind">ObjectKind</a> for possible values.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ObjectKind ObjectKind { 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.ObjectKind.html">ObjectKind</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_GameObject_OwnerId.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.OwnerId%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/Types/GameObject.cs/#L114">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_OwnerId_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.OwnerId*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_OwnerId" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.OwnerId">OwnerId</h4>
|
|
<div class="markdown level1 summary"><p>Gets the ID of this GameObject's owner.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public uint OwnerId { 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>
|
|
<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_GameObject_Position.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.Position%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/Types/GameObject.cs/#L140">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_Position_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.Position*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_Position" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.Position">Position</h4>
|
|
<div class="markdown level1 summary"><p>Gets the position of this <a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html">GameObject</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Vector3 Position { 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.Numerics.Vector3</span></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_GameObject_Rotation.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.Rotation%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/Types/GameObject.cs/#L146">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_Rotation_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.Rotation*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_Rotation" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.Rotation">Rotation</h4>
|
|
<div class="markdown level1 summary"><p>Gets the rotation of this <a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html">GameObject</a>.
|
|
This ranges from -pi to pi radians.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public float Rotation { 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.Single</span></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_GameObject_Struct.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.Struct%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/Types/GameObject.cs/#L170">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_Struct_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.Struct*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_Struct" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.Struct">Struct</h4>
|
|
<div class="markdown level1 summary"><p>Gets the underlying structure.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected GameObject*Struct { 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="FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject.html">GameObject</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_GameObject_SubKind.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.SubKind%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/Types/GameObject.cs/#L125">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_SubKind_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.SubKind*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_SubKind" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.SubKind">SubKind</h4>
|
|
<div class="markdown level1 summary"><p>Gets the sub kind of this Actor.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public byte SubKind { 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.Byte</span></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_GameObject_TargetObject.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.TargetObject%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/Types/GameObject.cs/#L165">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_TargetObject_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.TargetObject*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_TargetObject" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.TargetObject">TargetObject</h4>
|
|
<div class="markdown level1 summary"><p>Gets the target object of the game object.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual GameObject TargetObject { 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.Types.GameObject.html">GameObject</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Dalamud_Game_ClientState_Objects_Types_GameObject_TargetObject_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>This iterates the actor table, it should be used with care.</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_Game_ClientState_Objects_Types_GameObject_TargetObjectId.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.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/Types/GameObject.cs/#L156">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_TargetObjectId_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.TargetObjectId*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_TargetObjectId" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.TargetObjectId">TargetObjectId</h4>
|
|
<div class="markdown level1 summary"><p>Gets the current target of the game object.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual 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>
|
|
<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_GameObject_YalmDistanceX.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.YalmDistanceX%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/Types/GameObject.cs/#L130">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_YalmDistanceX_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.YalmDistanceX*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_YalmDistanceX" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.YalmDistanceX">YalmDistanceX</h4>
|
|
<div class="markdown level1 summary"><p>Gets the X distance from the local player in yalms.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public byte YalmDistanceX { 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.Byte</span></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_GameObject_YalmDistanceZ.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.YalmDistanceZ%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/Types/GameObject.cs/#L135">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_YalmDistanceZ_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.YalmDistanceZ*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_YalmDistanceZ" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.YalmDistanceZ">YalmDistanceZ</h4>
|
|
<div class="markdown level1 summary"><p>Gets the Y distance from the local player in yalms.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public byte YalmDistanceZ { 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.Byte</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<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_Game_ClientState_Objects_Types_GameObject_Equals_System_Object_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.Equals(System.Object)%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/Types/GameObject.cs/#L85">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_Equals_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.Equals*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_Equals_System_Object_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.Equals(System.Object)">Equals(Object)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override bool Equals(object obj)</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.Object</span></td>
|
|
<td><span class="parametername">obj</span></td>
|
|
<td></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.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><span class="xref">System.Object.Equals(System.Object)</span></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_Game_ClientState_Objects_Types_GameObject_GetHashCode.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.GetHashCode%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/Types/GameObject.cs/#L88">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_GetHashCode_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.GetHashCode*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_GetHashCode" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.GetHashCode">GetHashCode()</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override int GetHashCode()</code></pre>
|
|
</div>
|
|
<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.Int32</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><span class="xref">System.Object.GetHashCode()</span></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_Game_ClientState_Objects_Types_GameObject_IsValid.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.IsValid%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/Types/GameObject.cs/#L79">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_IsValid_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.IsValid*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_IsValid" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.IsValid">IsValid()</h4>
|
|
<div class="markdown level1 summary"><p>Gets a value indicating whether this actor is still valid in memory.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsValid()</code></pre>
|
|
</div>
|
|
<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.Boolean</span></td>
|
|
<td><p>True or false.</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_Game_ClientState_Objects_Types_GameObject_IsValid_Dalamud_Game_ClientState_Objects_Types_GameObject_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.IsValid(Dalamud.Game.ClientState.Objects.Types.GameObject)%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/Types/GameObject.cs/#L62">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_IsValid_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.IsValid*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_IsValid_Dalamud_Game_ClientState_Objects_Types_GameObject_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.IsValid(Dalamud.Game.ClientState.Objects.Types.GameObject)">IsValid(GameObject)</h4>
|
|
<div class="markdown level1 summary"><p>Gets a value indicating whether this actor is still valid in memory.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool IsValid(GameObject actor)</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><a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html">GameObject</a></td>
|
|
<td><span class="parametername">actor</span></td>
|
|
<td><p>The actor to check.</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.Boolean</span></td>
|
|
<td><p>True or false.</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_Game_ClientState_Objects_Types_GameObject_ToString.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.ToString%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/Types/GameObject.cs/#L173">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_ToString_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.ToString*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_ToString" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.ToString">ToString()</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
|
|
</div>
|
|
<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.String</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><span class="xref">System.Object.ToString()</span></div>
|
|
<h3 id="operators">Operators
|
|
</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_GameObject_op_Equality_Dalamud_Game_ClientState_Objects_Types_GameObject_Dalamud_Game_ClientState_Objects_Types_GameObject_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.op_Equality(Dalamud.Game.ClientState.Objects.Types.GameObject%2CDalamud.Game.ClientState.Objects.Types.GameObject)%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/Types/GameObject.cs/#L46">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_op_Equality_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.op_Equality*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_op_Equality_Dalamud_Game_ClientState_Objects_Types_GameObject_Dalamud_Game_ClientState_Objects_Types_GameObject_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.op_Equality(Dalamud.Game.ClientState.Objects.Types.GameObject,Dalamud.Game.ClientState.Objects.Types.GameObject)">Equality(GameObject, GameObject)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool operator ==(GameObject gameObject1, GameObject gameObject2)</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><a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html">GameObject</a></td>
|
|
<td><span class="parametername">gameObject1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html">GameObject</a></td>
|
|
<td><span class="parametername">gameObject2</span></td>
|
|
<td></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.Boolean</span></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_GameObject_op_Implicit_Dalamud_Game_ClientState_Objects_Types_GameObject__System_Boolean.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.op_Implicit(Dalamud.Game.ClientState.Objects.Types.GameObject)~System.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/Game/ClientState/Objects/Types/GameObject.cs/#L44">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_op_Implicit_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.op_Implicit*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_op_Implicit_Dalamud_Game_ClientState_Objects_Types_GameObject__System_Boolean" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.op_Implicit(Dalamud.Game.ClientState.Objects.Types.GameObject)~System.Boolean">Implicit(GameObject to Boolean)</h4>
|
|
<div class="markdown level1 summary"><p>This allows you to <code>if (obj) {...}</code> to check for validity.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static implicit operator bool (GameObject gameObject)</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><a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html">GameObject</a></td>
|
|
<td><span class="parametername">gameObject</span></td>
|
|
<td><p>The actor to check.</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.Boolean</span></td>
|
|
<td><p>True or false.</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_Game_ClientState_Objects_Types_GameObject_op_Inequality_Dalamud_Game_ClientState_Objects_Types_GameObject_Dalamud_Game_ClientState_Objects_Types_GameObject_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.op_Inequality(Dalamud.Game.ClientState.Objects.Types.GameObject%2CDalamud.Game.ClientState.Objects.Types.GameObject)%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/Types/GameObject.cs/#L55">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_op_Inequality_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.op_Inequality*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_op_Inequality_Dalamud_Game_ClientState_Objects_Types_GameObject_Dalamud_Game_ClientState_Objects_Types_GameObject_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.op_Inequality(Dalamud.Game.ClientState.Objects.Types.GameObject,Dalamud.Game.ClientState.Objects.Types.GameObject)">Inequality(GameObject, GameObject)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool operator !=(GameObject actor1, GameObject actor2)</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><a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html">GameObject</a></td>
|
|
<td><span class="parametername">actor1</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html">GameObject</a></td>
|
|
<td><span class="parametername">actor2</span></td>
|
|
<td></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.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="eii">Explicit Interface Implementations
|
|
</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_GameObject_System_IEquatable_Dalamud_Game_ClientState_Objects_Types_GameObject__Equals_Dalamud_Game_ClientState_Objects_Types_GameObject_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject.System%23IEquatable%7BDalamud%23Game%23ClientState%23Objects%23Types%23GameObject%7D%23Equals(Dalamud.Game.ClientState.Objects.Types.GameObject)%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/Types/GameObject.cs/#L82">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Game_ClientState_Objects_Types_GameObject_System_IEquatable_Dalamud_Game_ClientState_Objects_Types_GameObject__Equals_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.System#IEquatable{Dalamud#Game#ClientState#Objects#Types#GameObject}#Equals*"></a>
|
|
<h4 id="Dalamud_Game_ClientState_Objects_Types_GameObject_System_IEquatable_Dalamud_Game_ClientState_Objects_Types_GameObject__Equals_Dalamud_Game_ClientState_Objects_Types_GameObject_" data-uid="Dalamud.Game.ClientState.Objects.Types.GameObject.System#IEquatable{Dalamud#Game#ClientState#Objects#Types#GameObject}#Equals(Dalamud.Game.ClientState.Objects.Types.GameObject)">IEquatable<GameObject>.Equals(GameObject)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">bool IEquatable<GameObject>.Equals(GameObject other)</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><a class="xref" href="Dalamud.Game.ClientState.Objects.Types.GameObject.html">GameObject</a></td>
|
|
<td><span class="parametername">other</span></td>
|
|
<td></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.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<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_GameObject.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Objects.Types.GameObject%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/Types/GameObject.cs/#L94" 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>
|