NDGIC

From Legends of Aria Admin and Modding Wiki
Jump to: navigation, search

[Main] [Lua Examples]

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Global Functions & Examples

CallFunctionDelayed(...)

Params
TimeSpan - duration to wait before calling the function
function - function to call
Calls a function after the specified amount of time has elapsed Note: This function will not be called if server shuts down or restarts before the delay expires..

Example

-- call the TrapTriggered function after 2 seconds has elapsed
CallFunctionDelayed(TimeSpan.FromSeconds(2),TrapTriggered())
 
-- handle the target who triggered the trap by dealing 25 points of magic damage to the target
function TrapTriggered()
    -- get the target trigger object stored by the trap
    local target = this:GetObjVar("TrapTriggeredBy")
    -- if the target is valid apply the damage
    if(target) then
        damageInfo.Victim:SendMessage("DamageInflicted",target,25,"MAGIC",false,false,false,target)         
    end
end

CanPathTo(...)

Params
origin - the start location to path from
destination - the end location to path to
Checks for a valid path from the origin to the destination using A* algorithm.
Returns - true if worked, false if not

Example

-- attempt to move the target object to a new location
function MoveTargetToLoc(target,location)
    if(CanPathTo(this:GetLocation(),location) then
        -- move the target to the location specified
        target:PathTo(location,1,"ArrivedEventHandler",true,true,4)
        return true
    end
    -- if pathing failed return false
    return false
end 

ChangeWorld(...)

Params
reloadregion - true/false to reload the region
regionaddress - region to send players too
worldaddress - world adddress that contains the region
subregion - subregion to move players too
threads - number of object threads to run for the region
x - the x location to move the players too
z - the z location to move the players too
Changes or reloads the world on a standalone server.

Example

-- change the current region, will reset and reload
ChangeWorld(true)
-- change the current region to the black forest at location 550,375 with 8 threads and no reloading of the area
ChangeWorld(false,"AzureSky.NewCelador.BlackForest","NewCelador","BlackForest",8,550,375)

ClearBans()

Clears all active bans on the server..

Example

-- WARNING: THIS REMOVES ALL BANS ON THE SERVER
ClearBans()

CopyObjectToPos(...)

Params
object - object to copy
container - container to put in or nil
location - the location in the world or container
eventid - the event id for handling the created object
(...) one ore more variables to pass to the create event handler
Copy the specified object in a new position/container.

Example

--Copy a object into a users backpack
function DupeItemInPlayersBackpack(user,item) 
    local backpackObj = user:GetEquippedObject("Backpack")
    local location = GetRandomDropPosition(backpackObj)
    CopyObjectToPos(item,backpackObj,location,"DupeItemEventHandler")
end
--Copy a mobile to a location in the world
function CopyMonsterToLocation(user,mobile,location) 
    CopyObjectToPos(mobile,nil,location,"CopyMonsterToLocationHandler")
end

CreateCustomObj()

Params
templateid - the creation template id
templatedata - template data in a lua table
location - where to put it in the world
eventid - Event Handler Id for the Creation Event
(...)one ore more arguments passed to the createobject event
Spawn a new GameObj by using the specified lua table as the template in the world. NOTE: You can use (GetTemplateData(...)) to get a template table and modify it.

Example

 CODE EXAMPLE BLOCK

CreateCustomObjInContainer()

Params
template - creation template id for new object
templatedata - template data in a lua table
container - gameobj container
location - where in the world to put it
eventid - Event Handler identifier for the createdobject event
(...) - one ore more object arguments to be passed to the createdobject event
Spawn a new GameObj by using the specified lua table as the template in the world. NOTE: You can use (GetTemplateData(...)) to get a template table and modify it.

Example

 CODE EXAMPLE BLOCK

CreateCustomTempObj()

Params
templateid - the creation template id
templatedata - template data in a lua table
location - where to put it in the world
eventid - Event Handler Id for the Creation Event
(...)one ore more arguments passed to the createobject event
Spawn a new temporary GameObj by using the specified lua table as the template in the world. NOTE: You can use (GetTemplateData(...)) to get a template table and modify it.

Example

 CODE EXAMPLE BLOCK

CreateEquippedObj()

Params
template - template object to spawn
equipper - game object to equip too
eventid - event identifier for the resulting createdobject event
(...) - one ore more object arguments to be passed to the createdobject event
.Spawn a new GameObj directly to an equipment slot

Example

 CODE EXAMPLE BLOCK

CreateObjExtended()

Params
template - object template to be created
container - object to place in (nil if none)
location - location to spawn the object
rotation - (Loc) object rotation
scale - (Loc) object scale
eventid - event identifier for the resulting createdobject event
(...) One or more object arguments to be passed to the CreatedObject event. Function references are not supported
Spawn a new GameObj in the world

with a specfied rotation and scale.

Example

 CODE EXAMPLE BLOCK

CreateObjInContainer()

Params
template - template number to spawn
gameobject - game object of container
location - Where in the container to put it
eventid - event identifier for the resulting createdobject event
(...)One ore more object arguments to be passed to the created object event
Spawn a new GameObj inside a container object.

Example

 CODE EXAMPLE BLOCK

CreatePrefab()

Params
prefabname - name of the prefab to use
location - center location to place the prefab
eventid - event identifier for the resulting createdobject event
(...)One ore more object arguments to be passed to the created object event
Create group of dynamic objects relative to a specific position.

Example

 CODE EXAMPLE BLOCK

CreateTempObj()

Params
template - template name to spawn
location -where in the world to put it
eventid - event identifier for the resulting createdobject event
(...)One ore more object arguments to be passed to the created object event
Spawn a temporary GameObj in the world. Temporary objects are never stored in the backup and will disappear on restart.

Example

 CODE EXAMPLE BLOCK