De onderstaande code laat zien hoe het PluginMouse-object kan worden verkregen en
gebruikt in een plugin. Om deze code te gebruiken, plak je het in een `Script`, sla dat script
op in de lokale Plugins-map door met de rechtermuisknop te klikken en op 'Opslaan als' te klikken. De plugins
map kan worden gevonden in het tabblad Plugins in de Roblox Studio werkbalk.


Het PluginMouse-object geeft `Class.Plugin|Plugins` toegang tot de muis. Het
werkt als het `Class.Mouse`-object en kan worden verkregen met de plugin
`Class.Plugin:GetMouse()`-methode.

Let op dat de PluginMouse alleen kan worden gebruikt wanneer de plugin is geactiveerd met
`Class.Plugin:Activate()`.

Naast de functies van het `Class.Mouse`-object, bevat de PluginMouse
de `Class.PluginMouse.DragEnter`-functie die bijhoudt welke items
worden geselecteerd terwijl de muis sleept.

Voor meer informatie over het gebruik van muisobjecten, zie de `Class.Mouse`-pagina.


Geactiveerd wanneer Instanties worden geselecteerd terwijl de muis sleept.


PluginMouse.DragEnter

instances

Een array van de `Class.Instance|Instances` die in de
3D-weergave zijn ingevoegd door de sleep-en-neerzetbewerking.


PluginMouse

Het PluginMouse-object geeft `Class.Plugin|Plugins` toegang tot de muis. Het
werkt als het `Class.Mouse`-object en kan worden verkregen met de plugin
`Class.Plugin:GetMouse()`-methode.


**Muis** is vervangen door `Class.UserInputService` en
`Class.ContextActionService`, die een breder bereik hebben, rijker aan functies
zijn en **cross-platform** patronen beter ondersteunen. Het blijft ondersteund
vanwege het wijdverspreide gebruik, maar je moet sterk overwegen om deze
alternatieven te gebruiken.

Het **Muis**-object bevat verschillende API's voor pointers, voornamelijk voor knoppen
en raycasting. Het kan worden benaderd via `Class.Player:GetMouse()` dat wordt aangeroepen op
de `Class.Players.LocalPlayer` in een `Class.LocalScript`. Het wordt ook doorgegeven door
the `Class.Tool.Equipped`-evenement.

- Het is vooral opmerkelijk vanwege de `Class.Mouse.Icon|Icon`-eigenschap, die de
  uitstraling van de cursor verandert.
- Het raycast continu de schermpositie van de muis in de 3D-wereld met behulp van
  de `Class.Mouse.TargetFilter|TargetFilter`-eigenschap, waarbij de resultaten van
  de raycast worden opgeslagen in de `Class.Mouse.Hit|Hit`, `Class.Mouse.Target|Target`, en
  `Class.Mouse.TargetSurface|TargetSurface`-eigenschappen. Deze kunnen nuttig zijn
  voor eenvoudige gevallen, maar `Class.WorldRoot:Raycast()` moet worden gebruikt in meer
  gecompliceerde [raycasting](/workspace/raycasting) scenario's.
- `Class.Plugin|Plugins` kan `Class.Plugin:GetMouse()` gebruiken om een
  `Class.PluginMouse` te krijgen, dat zich op een vergelijkbare manier gedraagt.

```lua
-- Vanuit een LocalScript:
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local mouse = player:GetMouse()
-- De muisicoon instellen
mouse.Icon = "rbxasset://SystemCursors/Wait"
```
Opmerking:

- Dit object controleert/beperkt de beweging van de pointer niet. Hiervoor, zie
  `Class.UserInputService.MouseBehavior` en
  `Class.UserInputService.MouseDeltaSensitivity`.
- Als twee functies zijn verbonden met hetzelfde invoerevenement, zoals
  `Class.Mouse.Button1Down|Button1Down`, zullen **beide** functies worden uitgevoerd wanneer het
evenement wordt geactiveerd. Er is geen concept van sinken/doorgeven van invoer, aangezien evenementen deze
  gedrag niet ondersteunen. Echter, `Class.ContextActionService` heeft deze
  gedrag via `Class.ContextActionService:BindAction()|BindAction`.
- Hoewel een muis mogelijk niet beschikbaar is op alle platforms, zal de muis nog steeds
  functioneren op mobiel (aanraak) en console (gamepad), die doorgaans geen
  muizen of pointerhardware hebben. Voor expliciete cross-platform gedragingen, gebruik
  `Class.UserInputService` en `Class.ContextActionService`.

  Zie [Invoer en Camera](/input) voor meer informatie over
  het aanpassen van invoer in jouw ervaring.


Dit evenement wordt geactiveerd wanneer de speler zijn linkermuisknop indrukt. Let op
dat dit toegankelijk kan zijn vanuit een `Class.Tool`; bijvoorbeeld, wanneer geplaatst in
een `Class.LocalScript`, print de onderstaande code `Button1Down` telkens wanneer de
linkermuisknop wordt ingedrukt.

```lua
local tool = script.Parent  -- Zorg ervoor dat dit een Tool-object is

tool.Equipped:Connect(function(mouse)
	mouse.Button1Down:Connect(function()
		print("Button1Down")
	end)
end)
```
Je kunt de positie van de muis in de wereldruimte vinden en of het wijst naar een
`Class.BasePart` met behulp van de `Class.Mouse.Hit|Hit` en
`Class.Mouse.Target|Target` eigenschappen.


Mouse.Button1Down

Wordt geactiveerd wanneer de linkermuisknop wordt ingedrukt.


Dit evenement wordt geactiveerd wanneer de speler zijn linkermuisknop loslaat. Let op
dat dit toegankelijk kan zijn vanuit een `Class.Tool`; bijvoorbeeld, wanneer geplaatst in
een `Class.LocalScript`, print de onderstaande code `Button1Up` telkens wanneer de linkermuisknop
wordt losgelaten.

```lua
local tool = script.Parent  -- Zorg ervoor dat dit een Tool-object is

tool.Equipped:Connect(function(mouse)
	mouse.Button1Up:Connect(function()
		print("Button1Up")
	end)
end)
```
Je kunt de positie van de muis in de wereldruimte vinden en of het wijst naar een
`Class.BasePart` met behulp van de `Class.Mouse.Hit|Hit` en
`Class.Mouse.Target|Target` eigenschappen.


Mouse.Button1Up

Wordt geactiveerd wanneer de linkermuisknop wordt losgelaten.


Dit evenement wordt geactiveerd wanneer de speler zijn rechtermuisknop indrukt. Let op
dat dit toegankelijk kan zijn vanuit een `Class.Tool`; bijvoorbeeld, wanneer geplaatst in
een `Class.LocalScript`, print de onderstaande code `Button2Down` telkens wanneer de
rechtermuisknop wordt ingedrukt.

```lua
local tool = script.Parent  -- Zorg ervoor dat dit een Tool-object is

tool.Equipped:Connect(function(mouse)
	mouse.Button2Down:Connect(function()
		print("Button2Down")
	end)
end)
```
Je kunt de positie van de muis in de wereldruimte vinden en of het wijst naar een
`Class.BasePart` met behulp van de `Class.Mouse.Hit|Hit` en
`Class.Mouse.Target|Target` eigenschappen.


Mouse.Button2Down

Wordt geactiveerd wanneer de rechtermuisknop wordt ingedrukt.


Dit evenement wordt geactiveerd wanneer de speler zijn rechtermuisknop loslaat. Let op
dat dit toegankelijk kan zijn vanuit een `Class.Tool`; bijvoorbeeld, wanneer geplaatst in
een `Class.LocalScript`, print de onderstaande code `Button2Up` telkens wanneer de
rechtermuisknop wordt losgelaten.

```lua
local tool = script.Parent  -- Zorg ervoor dat dit een Tool-object is

tool.Equipped:Connect(function(mouse)
	mouse.Button2Up:Connect(function()
		print("Button2Up")
	end)
end)
```
Je kunt de positie van de muis in de wereldruimte vinden en of het wijst naar een
`Class.BasePart` met behulp van de `Class.Mouse.Hit|Hit` en
`Class.Mouse.Target|Target` eigenschappen.


Mouse.Button2Up

Wordt geactiveerd wanneer de rechtermuisknop wordt losgelaten.


Dit voorbeeld toont aan hoe muisgebeurtenissen tijdens elk frame worden doorgegeven


Wordt geactiveerd tijdens elke heartbeat dat de muis niet naar een ander
muisevenement wordt doorgegeven.

Let op, dit evenement moet niet worden gebruikt om te bepalen wanneer de muis stil is.
Aangezien het elke heartbeat wordt geactiveerd, zal het worden geactiveerd tussen
`Class.Mouse.Move`-evenementen.

Voor informatie over hoe je het `Class.Mouse`-object kunt verkrijgen, zie de
`Class.Mouse`-pagina.

Ontwikkelaars kunnen de positie van de muis in de wereldruimte vinden, en of
het wijst naar een `Class.BasePart` met behulp van de `Class.Mouse.Hit` en
`Class.Mouse.Target` eigenschappen.

Let op, ontwikkelaars wordt aangeraden om `Class.UserInputService` te gebruiken in plaats
van het `Class.Mouse`-object in nieuw werk.


Mouse.Idle

Wordt geactiveerd tijdens elke heartbeat dat de muis niet naar een ander
muisevenement wordt doorgegeven.


Het onderstaande voorbeeld, ervan uitgaande dat 'mouse' gedefinieerd was, zou de toets die
werd ingedrukt afdrukken (bijv. "q") samen met de ascii-waarde voor die toets (bijv. 113).


Dit evenement wordt geactiveerd wanneer een toets wordt ingedrukt, met het doorgegeven argument dat de
toets is die is ingedrukt.

Opmerking:

- Niet alle toetsen genereren dit evenement. Je kunt echter om dit te omzeilen met
  een paar van de toetsen, bijvoorbeeld "/", door gebruik te maken van het `Class.Mouse.KeyUp`
  evenement.
- Sommige toetsen genereren dezelfde string als andere toetsen.
- Het is mogelijk dat de string leeg is (mogelijk door "\\0" toetscode).


Mouse.KeyDown

Wordt geactiveerd wanneer een toets wordt ingedrukt.


Mouse.keyDown

Het onderstaande voorbeeld, ervan uitgaande dat 'mouse' gedefinieerd was, zou de toets die
werd losgelaten afdrukken (bijv. "q") samen met de ascii-waarde voor die toets (bijv. 113).


Dit evenement wordt geactiveerd wanneer een toets wordt losgelaten, met het doorgegeven argument dat de
toets is die is losgelaten.

Opmerking:

- Niet alle toetsen genereren dit evenement. Je kunt echter om dit te omzeilen met
  een paar van de toetsen, bijvoorbeeld "/", door gebruik te maken van de
  [[API:Class/Mouse/KeyUp|KeyUp]]-evenement.
- Sommige toetsen genereren dezelfde string als andere toetsen.
- Het is mogelijk dat de string leeg is (mogelijk door "\\0" toetscode).


Mouse.KeyUp

Wordt geactiveerd wanneer een toets wordt losgelaten.


Het onderstaande voorbeeld stelt de `Class.Players.LocalPlayer|lokale speler` in staat om
onderdelen te verplaatsen met hun muis.

Wanneer de speler op de linkermuisknop drukt boven een onderdeel, is dat onderdeel de
`Class.Mouse.Target|doel van de muis` en wordt het de _punt_. Totdat de speler
hun linkermuisknop loslaat, zal dat onderdeel verplaatsen naar de wereldpositie van de muis
wanneer de speler hun muis beweegt.

Let op dat de `Class.Mouse.TargetFilter` eigenschap de code toestaat om het
onderdeel dat wordt verplaatst te negeren bij het bepalen van de wereldpositie van de muis.

De code zou naar verwachting moeten werken wanneer deze in een `LocalScript` wordt geplaatst.


Wordt geactiveerd wanneer de muis wordt verplaatst.

Let op, dit evenement wordt geactiveerd wanneer de positie van de muis wordt bijgewerkt, daarom
zal het herhaaldelijk worden geactiveerd terwijl het wordt verplaatst.

Voor informatie over hoe je het `Class.Mouse`-object kunt verkrijgen, zie de
`Class.Mouse`-pagina.

Ontwikkelaars kunnen de positie van de muis in de wereldruimte vinden, en of
het wijst naar een `Class.BasePart` met behulp van de `Class.Mouse.Hit` en
`Class.Mouse.Target` eigenschappen.

```
mouse.Move:Connect(function()
	local position = mouse.Hit.p
	local target = mouse.Target
	print(target, position)
end)
```
Let op, ontwikkelaars wordt aangeraden om `Class.UserInputService` te gebruiken in plaats
van het `Class.Mouse`-object in nieuw werk.


Mouse.Move

Wordt geactiveerd wanneer de muis wordt verplaatst.


Het onderstaande voorbeeld gaat ervan uit dat je al de muis van de speler hebt gekregen (en
het als een variabele met de naam 'mouse' hebt ingesteld), of dit nu is door gebruik te maken van een `Class.Tool`,
`Class.HopperBin` of de `Class.Player:GetMouse()` methode. Het zal
"Het wiel ging achteruit!" afdrukken wanneer de speler achteruit scrollt.


Het WheelBackward-evenement wordt geactiveerd wanneer het muiswiel naar achteren wordt geschoven.
Mogelijke toepassingen voor dit evenement zijn het toggelen van de scope van een wapen in een eerste
persoon schieter (FPS) of het inzoomen van de camera van de speler.

Dit kan worden gebruikt naast het scrollen naar voren evenement,
`Class.Mouse.WheelForward`.

Voor informatie over hoe je het `Class.Mouse`-object kunt verkrijgen, zie de
`Class.Mouse`-pagina.

Let op, ontwikkelaars wordt aangeraden om `Class.UserInputService` te gebruiken in plaats
van het `Class.Mouse`-object in nieuw werk.


Mouse.WheelBackward

Wordt geactiveerd wanneer het muiswiel naar achteren wordt geschoven.


Het onderstaande voorbeeld gaat ervan uit dat je al de muis van de speler hebt verkregen (en
het als een variabele met de naam 'mouse' hebt ingesteld), of dit nu is door gebruik te maken van een `Tool`, `HopperBin`
of de `Class.Player:GetMouse()` methode. Het zal "Wiel ging vooruit!" afdrukken
wanneer de speler naar voren scrollt.


Het WheelForward-evenement wordt geactiveerd wanneer het muiswiel naar voren wordt geschoven.
Mogelijke toepassingen voor dit evenement zijn het toggelen van de scope van een wapen in een eerste
persoon schieter (FPS) of het inzoomen van de camera van de speler.

Dit kan worden gebruikt naast het scrollen naar achteren evenement,
`Class.Mouse.WheelBackward`.

Voor informatie over hoe je het `Class.Mouse`-object kunt verkrijgen, zie de
`Class.Mouse`-pagina.

Let op, ontwikkelaars wordt aangeraden om `Class.UserInputService` te gebruiken in plaats
van het `Class.Mouse`-object in nieuw werk.


Mouse.WheelForward

Wordt geactiveerd wanneer het muiswiel naar voren wordt geschoven.


Mouse

De code in dit voorbeeld, wanneer geplaatst binnen een `LocalScript` in
`StarterPlayerScripts`, zal een rode laserstraal tekenen tussen het hoofd van de
persoonlijkheid en `Class.Mouse.Hit` te allen tijde.

Let op, deze straal zal rechtstreeks door obstakels in de derde persoon gaan, omdat de
`Mouse`'s raycasting wordt gedaan vanuit de `Class.Workspace.CurrentCamera` en niet het
hoofd.


De onderstaande code visualiseert het verschil tussen `Class.Mouse.Hit` en
`Class.Mouse.Origin`. Om dit te doen, gebruikt de code de
`Datatype.Vector3` posities van de hit en oorsprong `Datatype.CFrame` waarden
met behulp van `.p`.

Het verschil is dat de oorsprong "waar de muis vandaan kwam" (zijn oorsprong)
en de hit de positie is waar de muis raakt (is wanneer de speler hun
muis indrukt).

Dit voorbeeld visualiseert ook dat de muis oorsprong erg lijkt op de
positie van de `CurrentCamera` door de magnitude (afstand) tussen
de twee posities af te drukken.


Deze eigenschap geeft de `Datatype.CFrame` van de positie van de muis in 3D
ruimte aan. Let op dat `Class.Mouse.TargetFilter` en zijn afstammelingen zullen worden
genegeerd.

Ontwikkelaars kunnen de positie van Hit als volgt verkrijgen:

```
local position = mouse.Hit.Position
```
Hit wordt vaak gebruikt door `Class.Tool|Tools` om een wapen naar de muis
in de derde persoon te vuren.

Ontwikkelaars die op zoek zijn naar de `Class.BasePart` waar de muis naar wijst,
moeten `Class.Mouse.Target` gebruiken.

#### Hoe wordt Mouse.Hit berekend?

De positie van de Hit CFrame wordt berekend als het snijpunt
tussen de interne `Datatype.Ray` van de muis (een uitgebreide versie van
`Class.Mouse.UnitRay`) en een object in 3D-ruimte (zoals een onderdeel).

De oriëntatie van de Hit CFrame komt overeen met de richting van de
`Class.Mouse.UnitRay`.

```
local unitRayDirection = mouse.UnitRay.Direction
local mouseHitDirection = mouse.Hit.lookVector
-- unitRayDirection ≈ mouseHitDirection
-- de vectoren zijn ongeveer gelijk
```
Let op, de roll van de `Class.Workspace.CurrentCamera` wordt niet gebruikt bij
het berekenen van de oriëntatie van de Hit `Datatype.CFrame`.

De interne straal van de muis strekt zich uit over 1.000 studs. Als de muis niet
wijst naar een object in 3D-ruimte (bijvoorbeeld wanneer hij naar de lucht wijst),
zal deze eigenschap 1.000 studs verwijderd zijn van de
`Class.Workspace.CurrentCamera`.


Mouse.Hit

De `Datatype.CFrame` van de positie van de muis in 3D-ruimte.


Mouse.hit

Dit voorbeeld verandert de `Class.Players.LocalPlayer` muisicoon zodat het eruitziet als een
draak afbeelding.


**Icoon** is een eigenschap die de afbeelding bepaalt die als de pointer wordt gebruikt. Als
leeg, wordt een standaardpijl gebruikt. Terwijl de cursor boven een
`Class.GuiButton` zweeft, wordt deze eigenschap tijdelijk genegeerd.

Om de cursor volledig te verbergen, **gebruik geen** transparante afbeelding &ndash;
zet in plaats daarvan `Class.UserInputService.MouseIconEnabled` op false.

Voor het verkrijgen/instellen van het gebruikersmuisicoon in ervaringen, moet je
`Class.UserInputService.MouseIcon` gebruiken. `Class.Mouse.Icon` zal verouderd zijn
after de nieuwe API voor plugins om de muiscursor in te stellen is vrijgegeven.

##### Een Cursor Ontwerpen

De volgende richtlijnen kunnen nuttig zijn bij het maken van je eigen muiscursors:

- De afmetingen van de gebruikte afbeelding bepalen de grootte van de cursor.
- De afmetingen van de afbeelding mogen niet groter zijn dan 256 pixels op enige as.
- Het **centrum** van de afbeelding is waar muisinvoer wordt uitgegeven.
- De standaard muisafbeelding is 64x64 pixels, waarbij de muis 17x24
  pixels ruimte in beslag neemt.

##### Systeem Cursors

Bij het gebruik van een `Class.PluginMouse` verkregen van `Class.Plugin:GetMouse()`,
kun je de volgende iconen gebruiken die vergelijkbaar zijn met de standaard cursors van je systeem,
zoals handen, pijlen, I-balken, enz. Je kunt deze gebruiken met GUI-evenementen
zoals `Class.GuiObject.MouseEnter|MouseEnter`,
`Class.GuiObject.MouseLeave|MouseLeave`, en
`Class.GuiButton.MouseButton1Down|MouseButton1Down` om een
consistente Studio-ervaring te bieden bij interactie met bepaalde soorten GUI
componenten. Let op dat deze alleen werken voor Studio-plugins; ze zullen niet
werken voor andere `Class.Mouse`-objecten.

<table>
    <thead>
        <tr>
            <th>Uiterlijk*</th>
            <th>Asset</th>
            <th>Aangeraden Gebruik</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Pointer.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Arrow</code></td>
            <td>Standaard klikken en selectie.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-PointingHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/PointingHand</code></td>
            <td>Hoveren boven een actieve link/knop.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-OpenHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/OpenHand</code></td>
            <td>Hoveren boven een versleepbaar item.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-GrabbingHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/ClosedHand</code></td>
            <td>Een item verslepen.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-IBeam.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/IBeam</code></td>
            <td>Hoveren in een tekstveld.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNS.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNS</code></td>
            <td>Hoveren boven een verticale resize-handgreep.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeEW.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeEW</code></td>
            <td>Hoveren boven een horizontale resize-handgreep.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNESW.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNESW</code></td>
            <td>Hoveren boven een hoekresize-handgreep.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNWSE.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNWSE</code></td>
            <td>Hoveren boven een hoekresize-handgreep.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeAll.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeAll</code></td>
            <td>Hoveren boven een multi-directionele resize-handgreep.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeSplitV.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SplitNS</code></td>
            <td>Hoveren boven een verticale "split"-handgreep.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeSplitH.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SplitEW</code></td>
            <td>Hoveren boven een horizontale "split"-handgreep.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Forbidden.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Forbidden</code></td>
            <td>Hoveren boven een vergrendeld/verboden item.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Wait.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Wait</code></td>
            <td>Aangeven dat een actie aan de gang is.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Busy.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Busy</code></td>
            <td>Aangeven dat het systeem druk is.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Crosshair.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Cross</code></td>
            <td>Hoveren boven een pinpoint-selectiegebied.</td>
        </tr>
    </tbody>
</table>

<figcaption>* Deze verschijningen zijn benaderingen &mdash; de werkelijke uitstraling is afhankelijk van je besturingssysteem.</figcaption>


Mouse.Icon

De content-ID van de afbeelding die wordt gebruikt als het `Class.Mouse`-icoon.


**Icoon** is een eigenschap die de afbeelding bepaalt die als de pointer wordt gebruikt. Als
leeg, wordt een standaardpijl gebruikt. Terwijl de cursor boven een
`Class.GuiButton` zweeft, wordt deze eigenschap tijdelijk genegeerd. Deze eigenschap
ondersteunt alleen asset-URI's.

Om de cursor volledig te verbergen, **gebruik geen** transparante afbeelding &ndash;
zet in plaats daarvan `Class.UserInputService.MouseIconEnabled` op false.

Voor het verkrijgen/instellen van het gebruikersmuisicoon in ervaringen, moet je
`Class.UserInputService.MouseIcon` gebruiken. `Class.Mouse.Icon` zal verouderd zijn
after de nieuwe API voor plugins om de muiscursor in te stellen is vrijgegeven.

##### Een Cursor Ontwerpen

De volgende richtlijnen kunnen nuttig zijn bij het maken van je eigen muiscursors:

- De afmetingen van de gebruikte afbeelding bepalen de grootte van de cursor.
- De afmetingen van de afbeelding mogen niet groter zijn dan 256 pixels op enige as.
- Het **centrum** van de afbeelding is waar muisinvoer wordt uitgegeven.
- De standaard muisafbeelding is 64x64 pixels, waarbij de muis 17x24
  pixels ruimte in beslag neemt.

##### Systeem Cursors

Bij het gebruik van een `Class.PluginMouse` verkregen van `Class.Plugin:GetMouse()`,
kun je de volgende iconen gebruiken die vergelijkbaar zijn met de standaard cursors van je systeem,
zoals handen, pijlen, I-balken, enz. Je kunt deze gebruiken met GUI-evenementen
zoals `Class.GuiObject.MouseEnter|MouseEnter`,
`Class.GuiObject.MouseLeave|MouseLeave`, en
`Class.GuiButton.MouseButton1Down|MouseButton1Down` om een
consistente Studio-ervaring te bieden bij interactie met bepaalde soorten GUI
componenten. Let op dat deze alleen werken voor Studio-plugins; ze zullen niet
werken voor andere `Class.Mouse`-objecten.

<table>
    <thead>
        <tr>
            <th>Uiterlijk*</th>
            <th>Asset</th>
            <th>Aangeraden Gebruik</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Pointer.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Arrow</code></td>
            <td>Standaard klikken en selectie.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-PointingHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/PointingHand</code></td>
            <td>Hoveren boven een actieve link/knop.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-OpenHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/OpenHand</code></td>
            <td>Hoveren boven een versleepbaar item.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-GrabbingHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/ClosedHand</code></td>
            <td>Een item verslepen.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-IBeam.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/IBeam</code></td>
            <td>Hoveren in een tekstveld.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNS.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNS</code></td>
            <td>Hoveren boven een verticale resize-handgreep.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeEW.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeEW</code></td>
            <td>Hoveren boven een horizontale resize-handgreep.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNESW.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNESW</code></td>
            <td>Hoveren boven een hoekresize-handgreep.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNWSE.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNWSE</code></td>
            <td>Hoveren boven een hoekresize-handgreep.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeAll.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeAll</code></td>
            <td>Hoveren boven een multi-directionele resize-handgreep.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeSplitV.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SplitNS</code></td>
            <td>Hoveren boven een verticale "split"-handgreep.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeSplitH.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SplitEW</code></td>
            <td>Hoveren boven een horizontale "split"-handgreep.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Forbidden.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Forbidden</code></td>
            <td>Hoveren boven een vergrendeld/verboden item.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Wait.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Wait</code></td>
            <td>Aangeven dat een actie aan de gang is.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Busy.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Busy</code></td>
            <td>Aangeven dat het systeem druk is.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Crosshair.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Cross</code></td>
            <td>Hoveren boven een pinpoint-selectiegebied.</td>
        </tr>
    </tbody>
</table>

<figcaption>* Deze verschijningen zijn benaderingen &mdash; de werkelijke uitstraling is afhankelijk van je besturingssysteem.</figcaption>


Mouse.IconContent

De inhoud van de afbeelding die wordt gebruikt als het `Class.Mouse`-icoon. Ondersteunt alleen
asset-URI's.


De oorsprong `Class.Mouse`-eigenschap is een `Datatype.CFrame` die aangeeft waar
de muis vandaan komt. Het is gepositioneerd bij de
`Class.Workspace.CurrentCamera` en georiënteerd naar de 3D-positie van de muis.

`Class.Mouse.UnitRay` begint op dezelfde positie als Oorsprong, en strekt zich uit
voor een stud in dezelfde richting.

```lua
local unitRay = mouse.UnitRay
local origin = mouse.Origin
-- unitRay.Direction = origin.p
-- unitRay.Direction ≈ origin.lookVector
```
Voor de positie van de `Class.Mouse` in 3D-ruimte, zie `Class.Mouse.Hit`.


Mouse.Origin

Een `Datatype.CFrame` gepositioneerd bij de `Class.Workspace.CurrentCamera` en
georiënteerd naar de 3D-positie van de muis.


Wanneer geplaatst in een `LocalScript` in `StarterPlayerScripts`, verandert de volgende code
 de `Class.BasePart.BrickColor` van elke `BasePart` waarop de speler klikt,
 zoals de spawnlocatie of basisplaat.


Het object in 3D-ruimte waar de `Class.Mouse|muis` naar wijst.

Opmerking:

- Als `Class.Mouse.TargetFilter` is ingesteld, wordt het doelfilter en zijn
  afstammelingen genegeerd.
- Wanneer de muis niet naar een `Class.BasePart` wijst, bijvoorbeeld wanneer
  hij naar de lucht wijst, zal Target `nil` zijn.
- Ontwikkelaars die op zoek zijn naar de positie van de muis in 3D-ruimte moeten
  `Class.Mouse.Hit` gebruiken.


Mouse.Target

Het object in 3D-ruimte waar de `Class.Mouse|muis` naar wijst.


Mouse.target

Deze eigenschap bepaalt een object dat door de muis moet worden genegeerd bij
het berekenen van `Class.Mouse.Hit` en `Class.Mouse.Target`. De afstammelingen van
to object worden ook genegeerd, zodat het mogelijk is om meerdere objecten te negeren
zolang ze een afstammeling zijn van het object waaraan deze eigenschap is
gehecht. Deze eigenschap is nuttig bij het filteren van modellen die speciale
effecten of decoraties bevatten die `Class.Mouse.Hit` of
`Class.Mouse.Target` niet mogen beïnvloeden.

Deze eigenschap kan worden ingesteld op elke `Class.Instance` of `nil`, bijvoorbeeld:

```lua
local Players = game:GetService("Players")
local Workspace = game:GetService("Workspace")

local player = Players.LocalPlayer
local mouse = player:GetMouse()
mouse.TargetFilter = Workspace.Model
```
Let op dat de `Class.Player.Character|Character` van de
`Class.Players.LocalPlayer` automatisch door de muis wordt genegeerd.


Mouse.TargetFilter

Bepaalt een object (en zijn afstammelingen) dat moet worden genegeerd bij het bepalen van
`Class.Mouse.Hit` en `Class.Mouse.Target`.


De code in dit voorbeeld, wanneer geplaatst in een `LocalScript` binnen
`StarterPlayerScripts`, zal het oppervlak van elk `BasePart` waarop geklikt wordt instellen op een
willekeurig oppervlak.


Deze eigenschap geeft de `Enum.NormalId` van het `Class.BasePart`
oppervlak aan waar de muis naar wijst. Deze eigenschap is afgeleid van de
wereldpositie van de muis (`Class.Mouse.Hit`) en het onderdeel waar de
muise naar wijst (`Class.Mouse.Target`).

Deze eigenschap is niet betekenisvol wanneer de muis niet naar een onderdeel wijst,
bijvoorbeeld wanneer de muis naar de lucht wijst. Op dit moment is deze
eigenschap ingesteld op 'Rechts' onder deze omstandigheden. Controleer voordat je deze
eigenschap gebruikt of het doel van de muis niet `nil` is.


Mouse.TargetSurface

Geeft de `Enum.NormalId` van het `Class.BasePart`-oppervlak aan waar de
muise naar wijst.


De UnitRay-eigenschap is een `Datatype.Ray` gericht naar de positie van de muis
in 3D-ruimte (beschreven door `Class.Mouse.Hit`). Het komt voort uit
de `Class.Camera.CFrame|CFrame` van de `Class.Workspace.CurrentCamera`.
Net als alle eenheidsstralen heeft het een afstand van 1.


Mouse.UnitRay

Een `Datatype.Ray` gericht naar de wereldpositie van de muis, afkomstig
van de wereldpositie van de `Class.Workspace.CurrentCamera`.


Dit codevoorbeeld laat zien hoe je een `Datatype.Vector2` kunt maken die de positie van het `Mouse`-object op het scherm vertegenwoordigt (`Class.Mouse.X|X()` en
`Class.Mouse.Y|Y()`) en de grootte van het scherm zelf
(`Class.Mouse.ViewSizeX|ViewSizeX()` en `Class.Mouse.ViewSizeY|ViewSizeY()`).
Met deze gegevens kun je de positie van de muis op het scherm normaliseren, zodat
links boven net onder de bovenbalk overeenkomt met (0, 0) en rechtsonder overeenkomt met
(1, 1). Deze genormaliseerde positie wordt berekend en afgedrukt terwijl de muis beweegt
met behulp van het `Class.Mouse.Move|Move()`-evenement.


De ViewSizeX-eigenschap beschrijft de horizontale component van de grootte van het spelvenster in pixels.


Mouse.ViewSizeX

Beschrijft de breedte van het spelvenster in pixels.


De ViewSizeY-eigenschap beschrijft de verticale component van de grootte van het spelvenster in pixels. Deze lengte omvat de ruimte die door de bovenbalk wordt gebruikt.


Mouse.ViewSizeY

Beschrijft de hoogte van het spelvenster in pixels.


Bij het detecteren van veranderingen in de positie van de muis op het scherm, is het
aanbevolen om `Class.ContextActionService:BindAction()` te gebruiken met
`Enum.UserInputType.MouseMovement` of
`Class.UserInputService.InputChanged`, die beide de positie van
de muis beschrijven met de `Class.InputObject.Position|Position` (een
`Datatype.Vector3`) van een `Class.InputObject`, in plaats van deze en
verwante eigenschappen te gebruiken.

De X-eigenschap beschrijft de horizontale component van de positie van de muis
op het scherm. De positie wordt gemeten in pixels ten opzichte van de linkerbovenhoek,
onder de bovenbalk. Deze eigenschap kan worden gebruikt in combinatie met
`Class.Mouse.Y` om een `Datatype.Vector2` te produceren die de positie van de muis vertegenwoordigt:

```lua
local position = Vector2.new(mouse.X, mouse.Y)
```
Deze eigenschap activeert geen `Class.Object.Changed|Changed` of het signaal
teruggegeven van
`Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal`. Gebruik
in plaats daarvan het `Class.Mouse.Move`-evenement.


Mouse.X

Beschrijft de X (horizontale) component van de positie van de muis op het
scherm.


Bij het detecteren van veranderingen in de positie van de muis op het scherm, is het
aanbevolen om `Class.ContextActionService:BindAction()` te gebruiken met
`Enum.UserInputType.MouseMovement` of
`Class.UserInputService.InputChanged`, die beide de positie van
de muis beschrijven met de `Class.InputObject.Position|Position` (een
`Datatype.Vector3`) van een `Class.InputObject`, in plaats van deze en
verwante eigenschappen te gebruiken.

De Y-eigenschap beschrijft de verticale component van de positie van de muis op
the scherm. De positie wordt gemeten in pixels ten opzichte van de linkerbovenhoek,
onder de bovenbalk. Deze eigenschap kan worden gebruikt in combinatie met
`Class.Mouse.X` om een `Datatype.Vector2` te produceren die de positie van de muis vertegenwoordigt:

```lua
local position = Vector2.new(mouse.X, mouse.Y)
```
Deze eigenschap activeert geen `Class.Object.Changed|Changed` of het signaal
teruggegeven van
`Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal`. Gebruik
in plaats daarvan het `Class.Mouse.Move`-evenement.


Mouse.Y

Beschrijft de Y (verticale) component van de positie van de muis op het scherm.


Legacy-object dat bevat leden die nuttig zijn voor pointerinvoer.


`Instance` is de basis klasse voor alle klassen in de Roblox klasse hiërarchie
waarvan de onderdelen deel kunnen uitmaken van de `Class.DataModel` boom.

Het is niet mogelijk om direct root `Instance` objecten te creëren, maar de speciale
`Datatype.Instance.new()` constructor creëert objecten via code, waarbij de
naam van de klasse als parameter wordt genomen en het gemaakte object wordt
teruggegeven.


Toont aan hoe veranderingen in de afstamming van een instantie kunnen worden gedetecteerd door verbinding te maken met het
`Class.Instance.AncestryChanged`-evenement.

De Parent van de ChangingPart wordt in de loop van de tijd op verschillende waarden ingesteld. De ouder van
de part is de voorouder van de part, dus het `Class.Instance.AncestryChanged`-evenement
zal worden geactiveerd telkens wanneer het verandert.


Wordt geactiveerd wanneer deze instantie opnieuw wordt gepaard of wanneer een van zijn voorouders wordt
gepaard.

Je kunt dit evenement gebruiken om de verwijdering van een instantie in Studio bij te houden,
zoals handmatige verwijdering in de Explorer of via een plugin. Als je moet
detecteren wanneer een instantie wordt vernietigd met `Class.Instance:Destroy()`,
gebruik dan in plaats daarvan het `Class.Instance.Destroying` evenement.


Instance.AncestryChanged

child

De instantie wiens `Class.Instance.Parent|Parent` eigenschap is gewijzigd,
wat deze instantie of een meer verre voorouder kan zijn, **niet**
per se de instantie waarmee de handler is verbonden.


parent

De nieuwe ouder van de `child` parameter.


Wordt geactiveerd wanneer de `Class.Instance.Parent` eigenschap van dit object of een van
zijn voorouders wordt gewijzigd.


Dit evenement wordt geactiveerd wanneer een eigenschap wordt gewijzigd op de instantie,
waaronder wanneer een eigenschap wordt ingesteld op `nil`. De naam van de gewijzigde
eigenschap wordt doorgegeven aan de verbonden functie.

Bijvoorbeeld, de volgende codefragment verbindt de `attributeChanged()`
funtie om te activeren wanneer een van de eigenschappen van het onderdeel verandert:

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace.Part

local function attributeChanged(attributeName)
	print(attributeName, "veranderd")
end

part.AttributeChanged:Connect(attributeChanged)
```
Zie ook `Class.Instance:GetAttributeChangedSignal()` die een
evenement retourneert dat wordt geactiveerd wanneer een specifieke gegeven eigenschap verandert.


Instance.AttributeChanged

attribute

De naam van de eigenschap die is gewijzigd.


Wordt geactiveerd wanneer een eigenschap wordt gewijzigd op de `Class.Instance`.


Dit fragment drukt de namen van objecten af wanneer ze aan de Workspace worden toegevoegd:


Wordt geactiveerd nadat een object aan deze `Class.Instance` is gepaard.

Let op, wanneer je deze methode op een client gebruikt om objecten te detecteren die door de
server zijn gemaakt, is het noodzakelijk om `Class.Instance:WaitForChild()` te gebruiken bij
het indexeren van de afstammelingen van deze objecten. Dit komt omdat het object en zijn
afstammelingen niet gegarandeerd gelijktijdig van de server naar de client worden gerepliceerd. Bijvoorbeeld:

```
local Workspace = game:GetService("Workspace")

Workspace.ChildAdded:Connect(function(child)
	-- Gebruik WaitForChild() aangezien afstammelingen mogelijk nog niet zijn gerepliceerd
	local head = child:WaitForChild("Head")
end)
```
Let op, dit evenement werkt alleen voor directe kinderen van de
`Class.Instance`. Voor een evenement dat alle afstammelingen vastlegt, gebruik
`Class.Instance.DescendantAdded`.

Zie ook `Class.Instance.ChildRemoved`.


Instance.ChildAdded

Wordt geactiveerd nadat een object aan deze `Class.Instance` is gepaard.


Instance.childAdded

Dit fragment drukt de namen van objecten af terwijl ze worden verwijderd uit de
Workspace:


Wordt geactiveerd nadat een kind is verwijderd uit deze `Class.Instance`.

Verwijderd verwijst naar wanneer de ouder van een object wordt gewijzigd van deze
`Class.Instance` naar iets anders dan deze `Class.Instance`. Let op, dit
evenement wordt ook geactiveerd wanneer een kind wordt vernietigd (met
`Class.Instance:Destroy()`) omdat de vernietigingsfunctie de ouder van een object
op `nil` instelt.

Dit evenement werkt alleen voor directe kinderen van de `Class.Instance`.
Voor een evenement dat alle afstammelingen vastlegt, gebruik
`Class.Instance.DescendantRemoving`.

Zie ook `Class.Instance.ChildAdded`.


Instance.ChildRemoved

Wordt geactiveerd nadat een kind is verwijderd uit deze `Class.Instance`.


Dit volgende voorbeeld zal de naam van elk object afdrukken dat wordt toegevoegd aan de
Workspace:


Dit evenement wordt geactiveerd nadat een afstammeling is toegevoegd aan de `Class.Instance`.

Aangezien het wordt geactiveerd voor elke afstammeling, zal het aanroepen van een object naar de
`Class.Instance` het evenement activeren voor dit object en al zijn
afstammelingen afzonderlijk.

Als je alleen geïnteresseerd bent in de **directe kinderen** van de
`Class.Instance`, gebruik dan in plaats daarvan `Class.Instance.ChildAdded`.

Zie ook `Class.Instance.DescendantRemoving`.


Instance.DescendantAdded

descendant

Wordt geactiveerd nadat een afstammeling is toegevoegd aan de `Class.Instance`.


Het volgende voorbeeld drukt de naam van elke afstammeling af terwijl deze wordt verwijderd
uit de Workspace:


Dit evenement wordt geactiveerd **onmiddellijk voordat** de ouder `Class.Instance`
verandert zodat een **afstammeling** instantie niet langer een
afstammeling zal zijn. `Class.Instance:Destroy()|Destroy()` verandert de ouder van een instantie naar
`nil`, dus het aanroepen van die methode op een afstammeling van de ouder zal dit evenement activeren.

Aangezien dit evenement wordt geactiveerd **voordat** de verwijdering van de afstammeling plaatsvindt, zal de ouder van
de afstammeling ongewijzigd blijven op het moment van het activeren van dit evenement. Als de
afstammeling ook een **direct kind** van de ouder is, zal dit evenement worden geactiveerd
voordat `Class.Instance.ChildRemoved`.

Als een afstammeling kinderen heeft, wordt dit evenement geactiveerd met de afstammeling eerst,
gevolgd door zijn afstammelingen.

#### Waarschuwing

Dit evenement wordt geactiveerd met het afstammelingobject dat wordt verwijderd.
Proberen de `Class.Instance.Parent|Parent` van de afstammeling naar iets anders in te stellen zal mislukken. Hieronder staat een voorbeeld dat dit aantoont:

```
local Workspace = game:GetService("Workspace")

Workspace.DescendantRemoving:Connect(function(descendant)
	-- Manipuleer de ouder van de afstammeling niet in deze functie!
	-- Dit evenement wordt geactiveerd OMDAT de ouder is gemanipuleerd, en de wijziging is nog niet gebeurd
	-- Daarom is het problematisch om de ouder op deze manier te veranderen:
	descendant.Parent = game
end)

local part = Instance.new("Part")
part.Parent = Workspace
part.Parent = nil
```
Zie ook `Class.Instance.DescendantAdded|DescendantAdded`.


Instance.DescendantRemoving

De `Class.Instance` die wordt verwijderd.


Wordt geactiveerd onmiddellijk voordat een afstammeling van de `Class.Instance` wordt verwijderd.


Dit voorbeeld demonstreert hoe, bij het gebruik van onmiddellijke signaalgedrag, een
Instance die wordt vernietigd op zijn plaats blijft totdat de verbonden functie yieldt.


Dit voorbeeld demonstreert hoe, bij het gebruik van uitgesteld signaalgedrag, een Instance
wordt vernietigd voordat het signaal wordt verzonden.


De `Class.Instance` zal nooit uit het geheugen worden verwijderd terwijl een verbonden
functie deze nog gebruikt. Echter, als de functie op enig moment onderbreekt,
zullen de `Class.Instance` en zijn afstammelingen naar `nil` worden gepaard.

Als de `Class.Workspace.SignalBehavior` eigenschap is ingesteld op
`Enum.SignalBehavior.Immediate`, wordt dit evenement onmiddellijk geactiveerd voordat de
`Class.Instance` of een van zijn voorouders wordt vernietigd met
`Class.Instance:Destroy()`.

Als de `Class.Workspace.SignalBehavior` eigenschap is ingesteld op
`Enum.SignalBehavior.Deferred`, wordt dit evenement geactiveerd op het volgende hervattingspunt,
wat zal zijn na de `Class.Instance` of een van zijn voorouders is vernietigd met `Class.Instance:Destroy()`.

Met `Enum.SignalBehavior.Deferred|Deferred` gedrag, is het problematisch om een script
te verbinden met zijn eigen `Class.Instance.Destroying` evenement, aangezien het script
zal worden vernietigd voordat de callback kan worden aangeroepen (wat betekent dat het niet
zal worden uitgevoerd).

Bij het verwijderen van een `Class.Instance` in Studio, zoals handmatig verwijderen
via de [Explorer](/studio/explorer) of via een plugin,
wordt de `Class.Instance` niet vernietigd. In plaats daarvan wordt de ouder ingesteld op `nil`
wat je kunt bijhouden met `Class.Instance.AncestryChanged`.


Instance.Destroying

Wordt geactiveerd onmiddellijk voordat (of wordt uitgesteld tot na) de instantie wordt
vernietigd via `Class.Instance:Destroy()`.


Toont `Class.Instance.StyledPropertiesChanged`.


Dit evenement wordt geactiveerd wanneer een stijl-eigenschap wordt gewijzigd op de instantie,
waaronder wanneer een eigenschap wordt ingesteld op `nil`.


Instance.StyledPropertiesChanged

Wordt geactiveerd wanneer een stijl-eigenschap wordt gewijzigd op de instantie, inclusief
wanneer een eigenschap wordt ingesteld op `nil`.


Deze methode past een tag toe op de instantie, zonder effect als de tag
al is toegepast. Het succesvol toevoegen van een tag zal een signaal activeren dat is
gemaakt door `Class.CollectionService:GetInstanceAddedSignal()` met de gegeven tag.

#### Waarschuwingen

- De tags van een instantie die client-side zijn toegevoegd, zullen worden verwijderd als de
  server later een tag aan die instantie toevoegt of verwijdert omdat de server
  alle tags samen repliceert en eerdere tags overschrijft.

- Bij het taggen van een instantie is het gebruikelijk dat er enkele middelen worden gebruikt om
  de tag zijn functionaliteit te geven, bijvoorbeeld gebeurteniskoppelingen of tabellen.
  Om geheugenlekken te voorkomen, is het een goed idee om deze op te ruimen (ontkoppelen,
  instellen op `nil`, enz.) wanneer ze niet langer nodig zijn voor een tag. Doe dit bij
  het aanroepen van `Class.Instance:RemoveTag()`, het aanroepen van
  `Class.Instance:Destroy()`, of in een functie die is verbonden met een signaal
  dat is geretourneerd door `Class.CollectionService:GetInstanceRemovedSignal()`.


Instance:AddTag

De tag die op de instantie moet worden toegepast.


De kinderen functie retourneert een array van de kinderen van het object.


Instance:children

Retourneert een array van de kinderen van het object.


Deze methode vernietigt alle kinderen en afstammelingen van een instantie.

```
local part = Instance.new("Part")

-- Voeg wat vonkels toe
for i = 1, 3 do
	local sparkles = Instance.new("Sparkles")
	sparkles.Parent = part

  local sc = Instance.new("Sparkles")
  sc.Parent = sparkles
end

print("Kinderen:", #part:GetChildren())  --> Kinderen: 3

part:ClearAllChildren()

print("Kinderen:", #part:GetChildren())  --> Kinderen: 0
```
Als je niet alle kinderen en afstammelingen wilt vernietigen, gebruik dan ofwel
`Class.Instance:GetChildren()` of `Class.Instance:GetDescendants()` om
door die kinderen/afstammelingen te lopen en te selecteren wat te vernietigen. Voor
voorbeeld, de volgende codevoorbeeld zal alle
`Class.BasePart|BaseParts` vernietigen die afstammen van een `Class.Model`:

```
local Workspace = game:GetService("Workspace")

local model = Workspace:FindFirstChild("TestModel")

for _, descendant in model:GetDescendants() do
	if descendant:IsA("BasePart") then
		descendant:Destroy()
	end
end
```


Instance:ClearAllChildren

Deze methode vernietigt alle kinderen van een instantie.


Toont het klonen van een model met `Class.Instance:Clone()`.


`Clone()` maakt een kopie van een instantie en al zijn afstammelingen,
negerend alle instanties die niet
`Class.Instance.Archivable|Archivable` zijn. De kopie van de root instantie wordt
teruggegeven door deze methode en zijn `Class.Instance.Parent|Parent` wordt ingesteld op
`nil`. Let op dat als de instantie zelf
`Class.Instance.Archivable|Archivable` is ingesteld op `false`, deze methode
`nil` zal retourneren.

Als een referentie-eigenschap zoals `Class.ObjectValue.Value` is ingesteld in een
gekloneerde instantie, hangt de waarde van de eigenschap van de kopie af van de
waarde van het origineel:

- Als een referentie-eigenschap verwijst naar een instantie die **ook** is gekloond,
  zal de kopie naar de kopie verwijzen.
- Als een referentie-eigenschap verwijst naar een instantie die **niet** is gekloond,
  wordt dezelfde waarde behouden in de kopie.


Instance:Clone

Een kopie van de instantie, of `nil` als de instantie niet
`Class.Instance.Archivable|Archivable` is.


Maak een kopie van een instantie en al zijn afstammelingen, negerend instanties
die niet `Class.Instance.Archivable|Archivable` zijn.


Instance:clone

Toont het vernietigen van een Deel met de `Class.Instance:Destroy()` functie.

Deze functie is de juiste manier om objecten weg te gooien die niet langer
vereist zijn.


Stelt de `Class.Instance.Parent` eigenschap in op `nil`, vergrendelt de
`Class.Instance.Parent` eigenschap, ontkoppelt alle verbindingen, en roept
`Destroy()` aan op alle kinderen. Deze methode is de juiste manier om objecten die
niet langer nodig zijn te verwijderen.

Het verwijderen van onnodige objecten is belangrijk, aangezien onnodige objecten en
verbindingen in een plaats geheugen gebruiken wat kan leiden tot ernstige prestatieproblemen
in de loop van de tijd.

Als beste praktijk na het aanroepen van `Destroy()` op een object, stel je alle
variabelen die naar het object (of zijn afstammelingen) verwijzen in op `nil`. Dit
voorkomt dat je code toegang heeft tot iets dat met het object te maken heeft.

```lua
local part = Instance.new("Part")
part.Name = "Hallo, wereld"
part:Destroy()
-- Doe dit niet:
print(part.Name)  --> "Hallo, wereld"
-- Doe dit om te voorkomen dat de bovenstaande regel werkt:
part = nil
```
Zodra een `Class.Instance` door deze methode is vernietigd, kan deze niet meer
worden hergebruikt omdat de `Class.Instance.Parent` eigenschap is vergrendeld. Om
**tijdelijk** een object te verwijderen in plaats van het te vernietigen, stel je
`Class.Instance.Parent|Parent` in op `nil`. Bijvoorbeeld:

```
local Workspace = game:GetService("Workspace")

object.Parent = nil
task.wait(2)
object.Parent = Workspace
```
Om een object na een bepaalde tijd te vernietigen, gebruik
`Class.Debris:AddItem()`.


Instance:Destroy

Stelt de `Class.Instance.Parent` eigenschap in op `nil`, vergrendelt de
`Class.Instance.Parent` eigenschap, ontkoppelt alle verbindingen, en roept
`Destroy()` aan op alle kinderen.


Instance:destroy

Retourneert de eerste voorouder van de `Class.Instance` wiens
`Class.Instance.Name` gelijk is aan de gegeven naam.

Deze methode werkt omhoog, wat betekent dat het begint bij de directe
`Class.Instance.Parent` van de instantie en omhoog werkt naar de `Class.DataModel`. Als er geen
overeenkomende voorouder wordt gevonden, retourneert het `nil`.

De volgende codefragment zou de eerste voorouder van het object
met de naam `Car` vinden.

```
local car = object:FindFirstAncestor("Car")
```
Voor varianten van deze methode die voorouders van een specifieke klasse vinden,
zie `Class.Instance:FindFirstAncestorOfClass()` en
`Class.Instance:FindFirstAncestorWhichIsA()`.


Instance:FindFirstAncestor

name

De `Class.Instance.Name` die moet worden gezocht.


Retourneert de eerste voorouder van de `Class.Instance` wiens
`Class.Instance.Name` gelijk is aan de gegeven naam.


Retourneert de eerste voorouder van de `Class.Instance` wiens
`Class.Object.ClassName` gelijk is aan de gegeven className.

Deze methode werkt omhoog, wat betekent dat het begint bij de directe
`Class.Instance.Parent` van de instantie en omhoog werkt naar de `Class.DataModel`. Als er geen
overeenkomende voorouder wordt gevonden, retourneert het `nil`.

Een veelgebruikte toepassing van deze methode is het vinden van de `Class.Model` waartoe
een `Class.BasePart` behoort. Bijvoorbeeld:

```
local model = part:FindFirstAncestorOfClass("Model")
```
Deze methode is een variant van `Class.Instance:FindFirstAncestor()` die
de `Class.Object.ClassName` eigenschap controleert in plaats van
`Class.Instance.Name`. `Class.Instance:FindFirstAncestorWhichIsA()` bestaat ook,
met gebruik van de `Class.Object:IsA()` methode in plaats daarvan om de klasse
overerving te respecteren.


Instance:FindFirstAncestorOfClass

className

De `Class.Object.ClassName` die moet worden gezocht.


Retourneert de eerste voorouder van de `Class.Instance` wiens
`Class.Object.ClassName` gelijk is aan de gegeven className.


Retourneert de eerste voorouder van de `Class.Instance` voor wie
`Class.Object:IsA()` waar retourneert voor de gegeven className.

Deze methode werkt omhoog, wat betekent dat het begint bij de directe
`Class.Instance.Parent` van de instantie en omhoog werkt naar de `Class.DataModel`. Als er geen
overeenkomende voorouder wordt gevonden, retourneert het `nil`.

In tegenstelling tot `Class.Instance:FindFirstAncestorOfClass()`, gebruikt deze methode
`Class.Object:IsA()` die de klasse overerving respecteert. Bijvoorbeeld:

```
print(part:IsA("Part"))  --> true
print(part:IsA("BasePart"))  --> true
print(part:IsA("Instance"))  --> true
```
Daarom zal de volgende codevoorbeeld de eerste
`Class.BasePart` voorouder retourneren, ongeacht of het een `Class.WedgePart`,
`Class.MeshPart` of `Class.Part` is.

```
local part = object:FindFirstAncestorWhichIsA("BasePart")
```
Zie ook `Class.Instance:FindFirstAncestor()`.


Instance:FindFirstAncestorWhichIsA

Retourneert de eerste voorouder van de `Class.Instance` voor wie
`Class.Object:IsA()` waar retourneert voor de gegeven className.


Het onderstaande zou in Workspace zoeken naar een object met de naam "Brick". Als het gevonden wordt, 
zult het de naam van het object veranderen in "Foo".


Retourneert het eerste kind van de `Class.Instance` met de gegeven naam, of
`nil` als er geen dergelijk kind bestaat. Als de optionele `recursief` argument is
`true`, zoekt deze methode door alle afstammelingen in plaats van alleen de
directe kinderen van de `Class.Instance`.

#### Controleren of een Object Bestaat

`FindFirstChild()` is noodzakelijk als je moet verifiëren of een object bestaat
voordat je verder gaat. Proberen om een kind op naam te indexeren met de punt
operator genereert een fout als het kind niet bestaat.

```lua
local Workspace = game:GetService("Workspace")

-- De volgende regel genereert een fout als het onderdeel niet bestaat in de workspace
Workspace.Part.Transparency = 0.5
```
Een betere aanpak is om `FindFirstChild()` te gebruiken om eerst te controleren op `Part`,
vervolgens een `if`-verklaring te gebruiken om code uit te voeren die het nodig heeft.

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace:FindFirstChild("Part")
if part then
	part.Transparency = 0.5
end
```

#### Een Kind Vinden Wiens Naam Een Eigenschap Overeenkomt

Soms is de `Class.Instance.Name|Name` van een object hetzelfde als dat van een
eigenschap van zijn `Class.Instance.Parent|Parent`. Bij gebruik van de punt
operator hebben eigenschappen voorrang boven kinderen als ze dezelfde naam delen.

In het volgende voorbeeld wordt een `Class.Folder` genaamd `Color` toegevoegd aan een
`Class.Part`, die ook de `Class.Part.Color` eigenschap heeft. Merk op dat
`part.Color` verwijst naar de `Datatype.Color3` eigenschapswaarde, niet de kind
`Class.Folder` instantie. Een voordeel van het gebruik van
`Class.Instance:FindFirstChild()|FindFirstChild()` is dat de introductie van nieuwe
 eigenschappen geen risico voor je code met zich meebrengt.

```lua
local part = Instance.new("Part")
local folder = Instance.new("Folder")
folder.Name = "Color"
folder.Parent = part
local c1 = part.Color  -- De eigenschap
local c2 = part:FindFirstChild("Color")  -- De kindmap
```

#### Prestatie Opmerkingen

`Class.Instance:FindFirstChild()|FindFirstChild()` duurt ongeveer 20% langer
 dan het gebruik van de punt operator en bijna 8 keer langer dan simpelweg het opslaan
 van een referentie naar een object. Daarom moet je het vermijden om het aan te roepen in
 prestatie-afhankelijke code zoals in strakke lussen of functies die zijn verbonden
 met `Class.RunService.Heartbeat` en `Class.RunService.PreRender`. In plaats daarvan,
 sla het resultaat op in een variabele, of overweeg om
 `Class.Instance.ChildAdded|ChildAdded` of
 `Class.Instance:WaitForChild()|WaitForChild()` te gebruiken om te detecteren wanneer een kind van een
gegeven naam beschikbaar wordt.


Instance:FindFirstChild

De `Class.Instance.Name` die moet worden doorzocht.


recursive

Of de zoekopdracht recursief moet worden uitgevoerd.


Retourneert het eerste kind van de `Class.Instance` gevonden met de gegeven naam.


Instance:findFirstChild

Retourneert het eerste kind van de `Class.Instance` wiens
`Class.Object.ClassName|ClassName` gelijk is aan de gegeven `className`.
In tegenstelling tot `Class.Instance:FindFirstChildWhichIsA()`, retourneert deze methode alleen
objecten wiens klasse overeenkomt met `className`, waarbij klasse overerving wordt genegeerd. Als er geen
overeenkomend kind wordt gevonden, retourneert deze methode `nil`.


Instance:FindFirstChildOfClass

Retourneert het eerste kind van de `Class.Instance` wiens
`Class.Object.ClassName|ClassName` gelijk is aan de gegeven class naam.


Retourneert het eerste kind van de `Class.Instance` voor wie
`Class.Object:IsA()` waar retourneert voor de gegeven className.

Als er geen overeenkomend kind wordt gevonden, retourneert deze methode `nil`. Als het optionele
recursieve argument waar is, zoekt deze methode door alle afstammelingen in plaats
van alleen de directe kinderen van de `Class.Instance`.

In tegenstelling tot `Class.Instance:FindFirstChildOfClass()`, gebruikt deze methode
`Class.Object:IsA()` die de klasse overerving respecteert. Bijvoorbeeld:

```lua
print(part:IsA("Part")) --> true
print(part:IsA("BasePart")) --> true
print(part:IsA("Instance")) --> true
```
Daarom zal de volgende codevoorbeeld het eerste
`Class.BasePart` kind retourneren, ongeacht of het een `Class.WedgePart`,
`Class.MeshPart` of `Class.Part` is.

```
local part = object:FindFirstChildWhichIsA("BasePart")
```
Ontwikkelaars die naar een kind zoeken op naam, moeten
`Class.Instance:FindFirstChild()` in plaats daarvan gebruiken.


Instance:FindFirstChildWhichIsA

Retourneert het eerste kind van de `Class.Instance` voor wie
`Class.Object:IsA()` waar retourneert voor de gegeven className.


Retourneert de eerste afstammeling die is gevonden met de gegeven `Class.Instance.Name`.

Deze methode is uitgeschakeld en kan niet worden gebruikt. Om de eerste afstammeling
van een instantie te vinden, overweeg om de `recursieve` parameter op
`Class.Instance:FindFirstChild()` in plaats daarvan te gebruiken.


Instance:FindFirstDescendant

De `Class.Instance.Name` om naar te zoeken.


Retourneert de eerste afstammeling die is gevonden met de gegeven `Class.Instance.Name`.


Als de `Class.Instance` een `Class.Actor` is, wordt de `Class.Actor` zelf
teruggegeven. Anders wordt de dichtstbijzijnde voorouder `Class.Actor` teruggegeven. Als er geen
voorouder een `Class.Actor` is, is het resultaat `nil`.


Instance:GetActor

Retourneert de `Class.Actor` die aan de instantie is gekoppeld, indien aanwezig.


Deze methode retourneert de waarde die is toegewezen aan de gegeven
attribuutnaam. Als er geen attribuut is toegewezen, wordt `nil` geretourneerd.

Bijvoorbeeld, de volgende codefragment stelt de waarde in en haalt vervolgens de waarde van
de instantie's `InitialPosition` attribuut op:

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace.Part
part:SetAttribute("InitialPosition", part.Position)

local initialPosition = instance:GetAttribute("InitialPosition")
print(initialPosition)
```

#### Zie Ook

- `Class.Instance:SetAttribute()` die het attribuut met de gegeven
  naam instelt op de gegeven waarde.
- `Class.Instance:GetAttributes()` die een woordenboek van sleutel-waarde
  paren retourneert voor elk van de instanties attributen.


Instance:GetAttribute

De naam van het attribuut dat wordt opgehaald.


De waarde die is toegewezen aan de gegeven attribuutnaam. Als er geen
attribuut is toegewezen, wordt `nil` geretourneerd.


Retourneert de waarde die is toegewezen aan de gegeven attribuutnaam.


Deze methode retourneert een gebeurtenis die zich precies gedraagt als de
`Class.Object.Changed|Changed` gebeurtenis, behalve dat deze alleen wordt geactiveerd wanneer het
specifieke gegeven attribuut verandert; effectief is het vergelijkbaar met
`Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal()` maar
voor attributen.

Het is over het algemeen een goed idee om deze methode te gebruiken in plaats van een verbinding met
`Class.Object.Changed|Changed` met een functie die de attribuutnaam controleert. Volgende aanroepen van deze methode op hetzelfde object met dezelfde
attribuutnaam retourneren hetzelfde evenement.

Het volgende codevoorbeeld retourneert een signaal dat de functie
`attributeChanged()` activeert wanneer het attribuut `InitialPosition` van het onderdeel verandert:

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace.Part
part:SetAttribute("InitialPosition", part.Position)

local function attributeChanged()
	print("Attribuut veranderd")
end

part:GetAttributeChangedSignal("InitialPosition"):Connect(attributeChanged)
```
Zie ook `Class.Instance.AttributeChanged` die wordt geactiveerd wanneer elk
attribuut op de instantie verandert.


Instance:GetAttributeChangedSignal

De naam van het gespecificeerde attribuut waarvoor het wijzigingssignaal
wordt geretourneerd.


Een gebeurtenis die wordt geactiveerd wanneer het gegeven attribuut verandert.


Retourneert een gebeurtenis die wordt geactiveerd wanneer het gegeven attribuut verandert.


Deze methode retourneert een woordenboek van sleutel-waarde paren voor elk attribuut
waarbij de sleutel de naam van het attribuut is en de waarde een niet-`nil` waarde.

Bijvoorbeeld, de volgende codefragment geeft de attributen en waarden van een instantie weer:

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace.Part
part:SetAttribute("InitialPosition", part.Position)
part:SetAttribute("CanUse", true)

for name, value in part:GetAttributes() do
	print(name .. " = " .. value)
end
```
Zie ook `Class.Instance:GetAttribute()` die de waarde retourneert die is
toegewezen aan de gegeven attribuutnaam.


Instance:GetAttributes

Een woordenboek van string → variant paren voor elk attribuut waarbij de
string de naam van het attribuut is en de variant een niet-nil
waarde.


Retourneert een woordenboek van de attributen van de instantie.


Instance

`Instance` is de basis klasse voor alle klassen in de Roblox klasse hiërarchie
waarvan de onderdelen deel kunnen uitmaken van de `Class.DataModel` boom.


/reference/engine/classes/PluginMouse.yaml

Samenvatting