GetElementSyncer: Difference between revisions

Revision as of 16:14, 23 April 2009

This function gets the syncer of an element. The syncer is the player who is in control of the element.

Syntax

element getElementSyncer ( element theElement )

Required Arguments

theElement: The element to get the syncer of.

Returns

Returns the element that is the syncer of theElement or false if the element is not being synced.

Example

Click to collapse [-]

Server

This code will kill the syncer of the first ped created with createPed.

local elementSyncer = getElementSyncer(getElementsByType("ped")[1])
if elementSyncer and getElementType(elementSyncer) == "player" then --Check if its a player and if there is a syncer
    killPed(elementSyncer, elementSyncer)
end

This code will kill the syncer of the ped created with createPed.

function test(player,commandName)
    local idlewoodPed = createPed(26,1813.27,-1897.04,13.577)
    local elementSyncer = getElementSyncer(idlewoodPed)
    if elementSyncer and getElementType(elementSyncer) == "player" then --Check if its a player and if there is a syncer
        killPed(elementSyncer, elementSyncer)
    end
end
addCommandHandler("test", test, false)

@@ Line 1: / Line 1: @@
+__NOTOC__
+{{Server function}}
+This function gets the syncer of an element. The syncer is the player who is in control of the element.
+==Syntax==
+<syntaxhighlight lang="lua">
+element getElementSyncer ( element theElement )
+</syntaxhighlight>
+===Required Arguments===
+* '''theElement''': The [[element]] to get the syncer of.
+===Returns===
+Returns the [[element]] that is the syncer of ''theElement'' or ''false'' if the element is not being synced.
 ==Example==
 <section name="Server" class="server" show="true">
-==Example 1==
 This code will kill the syncer of the first ped created with createPed.
 <syntaxhighlight lang="lua">
 local elementSyncer = getElementSyncer(getElementsByType("ped")[1])
 if elementSyncer and getElementType(elementSyncer) == "player" then --Check if its a player and if there is a syncer
-     killPed(elementSyncer,elementSyncer)
+     killPed(elementSyncer, elementSyncer)
 end
 </syntaxhighlight>
-==Example 2==
 This code will kill the syncer of the ped created with createPed.
 <syntaxhighlight lang="lua">
@@ Line 16: / Line 29: @@
      local elementSyncer = getElementSyncer(idlewoodPed)
      if elementSyncer and getElementType(elementSyncer) == "player" then --Check if its a player and if there is a syncer
-         killPed(elementSyncer,elementSyncer)
+         killPed(elementSyncer, elementSyncer)
      end
 end
-addCommandHandler("test",test,false)
+addCommandHandler("test", test, false)
 </syntaxhighlight>
 </section>