ScriptBind_Action

LoadXML

Action.LoadXML(definitionFile, dataFile)
ParameterDescription
definitionFile.
dataFileXML-lua data file name.

SaveXML

Action.SaveXML(definitionFile, dataFile, dataTable)
ParameterDescription
definitionFile.
dataFileXML-lua data file name.
dataTable.

IsServer

Action.IsServer()
Returns: true if the current script runs on a server.

IsClient

Action.IsClient()
Returns: true if the current script runs on a client.

IsGameStarted

true if the game has started.

Action.IsGameStarted()

IsRMIServer

true if the current script is running on an RMI (Remote Method Invocation) server.

Action.IsRMIServer()

GetPlayerList

Checks the current players list.

Action.GetPlayerList()

IsGameObjectProbablyVisible

Action.IsGameObjectProbablyVisible( gameObject )
Returns: true if an object is probably visible.
ParameterDescription
gameObjectObject that we want to check.

ActivateEffect

Activates the specified effect.

Action.ActivateEffect( name )
ParameterDescription
nameName of the effect.

GetWaterInfo

Gets information about the water at the position pos.

Action.GetWaterInfo( pos )
ParameterDescription
posPosition to be checked.

SetViewCamera

Saves the previous valid view and override it with the current camera settings.

Action.SetViewCamera()

ResetToNormalCamera

Resets the camera to the last valid view stored.

Action.ResetToNormalCamera()

GetServer

Gets the server.

Action.GetServer( number )

RefreshPings

Refreshes pings for all the servers listed.

Action.RefreshPings()

ConnectToServer

Connects to the specified server.

Action.ConnectToServer( server )
ParameterDescription
serverString that specifies the server to be used for the connection.

GetServerTime

Gets the current time on the server.

Action.GetServerTime()

PauseGame

Puts the game into pause mode.

Action.PauseGame( pause )
ParameterDescription
pauseTrue to set the game into the pause mode, false to resume the game.

IsImmersivenessEnabled

Action.IsImmersivenessEnabled()
Returns: true if immersive multiplayer is enabled.

IsChannelSpecial

Action.IsChannelSpecial()
Returns: true if the channel is special.

ForceGameObjectUpdate

Forces the game object to be updated.

Action.ForceGameObjectUpdate( entityId, force )
ParameterDescription
entityIdIdentifier for the entity.
forceTrue to force the update, false otherwise.

CreateGameObjectForEntity

Creates a game object for the specified entity.

Action.CreateGameObjectForEntity( entityId )
ParameterDescription
entityIdIdentifier for the entity.

BindGameObjectToNetwork

Binds game object to the network.

Action.BindGameObjectToNetwork( entityId )
ParameterDescription
entityIdIdentifier for the entity.

ActivateExtensionForGameObject

Activates a specified extension for a game object.

Action.ActivateExtensionForGameObject( entityId, extension, activate )
ParameterDescription
entityIdIdentifier for the entity.
extensionExtension name.
activateTrue to activate the extension, false to deactivate it.

SetNetworkParent

Sets the network parent.

Action.SetNetworkParent( entityId, parentId )
ParameterDescription
entityIdIdentifier for the entity.
parentIDIdentifier for the parent network.

IsChannelOnHold

Action.IsChannelOnHold( channelId )
ParameterDescription
channelIdIdentifier for the channel. Checks if the specified channel is on hold.

BanPlayer

Bans a specified player.

Action.BanPlayer( entityId, message )
ParameterDescription
entityIdIdentifier for the entity.
messageMessage for the ban.

PersistantSphere

Adds a persistent sphere to the world.

Action.PersistantSphere( pos, radius, color, name, timeout )
ParameterDescription
posPosition of the sphere.
radiusRadius of the sphere.
colorColor of the sphere.
nameName assigned to the sphere.
timeoutTimeout for the sphere.

PersistantLine

Adds a persistent line to the world.

Action.PersistantLine( start, end, color, name, timeout ) 
ParameterDescription
startStarting position of the line.
endEnding position of the line.
colorColor of the line.
nameName assigned to the line.
timeoutTimeout for the line.

PersistantArrow

Adds a persistent arrow to the world.

Action.PersistantArrow( pos, radius, dir, color, name, timeout )
ParameterDescription
posPosition of the arrow.
radiusRadius of the arrow.
dirDirection of the arrow.
colorColor of the arrow.
nameName assigned to the arrow.
timeoutTimeout for the arrow.

Persistant2DText

Adds a persistent 2D text.

Action.Persistant2DText( text, size, color, name, timeout )
ParameterDescription
textText that has to be displayed.
sizeSize of the 2D text.
colorColor of the 2D text.
nameName assigned to the 2D text.
timeoutTimeout for the 2D text.

PersistantEntityTag

Adds a persistent entity tag.

Action.PersistantEntityTag( entityId, text )
ParameterDescription
entityIdIdentifier for the entity.
textText for the entity tag.

ClearEntityTags

Clears the tag for the specified entity.

Action.ClearEntityTags( entityId )
ParameterDescription
entityIdIdentifier for the entity.

ClearStaticTag

Clears the specified static tag for the specified entity.

Action.ClearStaticTag( entityId, staticId )
ParameterDescription
entityIdIdentifier for the entity.
staticIdIdentifier for the static tag.

SendGameplayEvent

Sends an event for the gameplay.

Action.SendGameplayEvent( entityId, event )
ParameterDescription
entityIdIdentifier for the entity.
eventInteger for the event.

CacheItemSound

Caches an item sound.

Action.CacheItemSound( itemName )
ParameterDescription
itemNameItem name string.

CacheItemGeometry

Caches an item geometry.

Action.CacheItemGeometry( itemName )
ParameterDescription
itemNameItem name string.

DontSyncPhysics

Doesn't sync physics for the specified entity.

Action.DontSyncPhysics( entityId )
ParameterDescription
entityIdIdentifier for the entity.

EnableSignalTimer

Action.EnableSignalTimer( entityId, sText )
ParameterDescription
entityIdIdentifier for the entity.
sTextText for the signal.

DisableSignalTimer

Disables the signal timer.

Action.DisableSignalTimer( entityId, sText )
ParameterDescription
entityIdIdentifier for the entity.
sTextText for the signal.

SetSignalTimerRate

Sets the rate for the signal timer.

Action.SetSignalTimerRate( entityId, sText, fRateMin, fRateMax )
ParameterDescription
entityIdIdentifier for the entity.
sTextText for the signal.
fRateMinMinimum rate for the signal timer.
fRateMaxMaximum rate for the signal timer.

ResetSignalTimer

Resets the rate for the signal timer.

Action.ResetSignalTimer( entityId, sText )
ParameterDescription
entityIdIdentifier for the entity.
sTextText for the signal.

EnableRangeSignaling

Enable/Disable range signalling for the specified entity.

Action.EnableRangeSignaling( entityId, bEnable )
ParameterDescription
entityIdIdentifier for the entity.
bEnableEnable/Disable range signalling.

DestroyRangeSignaling

Action.DestroyRangeSignaling( entityId )
ParameterDescription
entityIdIdentifier for the entity.

ResetRangeSignaling

Action.ResetRangeSignaling( entityId )
ParameterDescription
entityIdIdentifier for the entity.

AddRangeSignal

Adds a range for the signal.

Action.AddRangeSignal( entityId, fRadius, fFlexibleBoundary, sSignal )
ParameterDescription
entityIdIdentifier for the entity.
fRadiusRadius of the range area.
fFlexibleBoundaryFlexible boundary size.
sSignalString for signal.

AddTargetRangeSignal

Action.AddTargetRangeSignal( entityId, targetId, fRadius, fFlexibleBoundary, sSignal )
ParameterDescription
entityIdIdentifier for the entity.
targetIdIdentifier for the target.
fRadiusRadius of the range area.
fFlexibleBoundaryFlexible boundary size.
sSignalString for signal.

AddAngleSignal

Adds an angle for the signal.

Action.AddRangeSignal( entityId, fAngle, fFlexibleBoundary, sSignal )
ParameterDescription
entityIdIdentifier for the entity.
fAngleAngle value.
fFlexibleBoundaryFlexible boundary size.
sSignalString for signal.

RegisterWithAI

Registers the entity to AI System, creating an AI object associated to it.

Action.RegisterWithAI()

HasAI

Action.HasAI( entityId )
Returns: true if the entity has an AI object associated to it, meaning it has been registered with the AI System

GetClassName

Action.GetClassName( classId )
Returns: the matching class name if available for specified classId.

SetAimQueryMode

Set the aim query mode for the ai proxy. Normally the ai proxy asks the movement controller if the character is aiming. You can override that and set your own 'isAiming' state.

Action.SetAimQueryMode( entityId, mode )
ParameterDescription
entityIdIdentifier for the entity.
modeQueryAimFromMovementController or OverriddenAndAiming or OverriddenAndNotAiming

PreLoadADB

Use this function to pre-cache ADB files.

Action.PreLoadADB( adbFileName )
ParameterDescription
adbFileNameThe path and filename of the animation ADB file which is to be pre-loaded.