|
Warhorse ScripBind documentation
|
   |
   |
CScriptBindAction Methods
|
Warhorse ScripBind documentation
|
|
|
The methods of the CScriptBindAction class are listed here.
|
|
Name |
Description |
 |
Syntax: Action.ActivateEffect( name ) Activates the specified effect. | |
|
|
Syntax: Action.ActivateExtensionForGameObject( entityId, extension, activate ) Activates a specified extension for a game object. | |
|
|
Syntax: Action.AddRangeSignal( entityId, fAngle, fFlexibleBoundary, sSignal ) Adds an angle for the signal. | |
|
|
Syntax: Action.AddRangeSignal( entityId, fRadius, fFlexibleBoundary, sSignal ) Adds a range for the signal. | |
|
|
Syntax: Action.AddTargetRangeSignal( entityId, targetId, fRadius, fFlexibleBoundary, sSignal ) | |
|
|
Syntax: Action.BanPlayer( entityId, message ) Bans a specified player. | |
|
|
Syntax: Action.BindGameObjectToNetwork( entityId ) Binds game object to the network. | |
|
|
Syntax: Action.CacheItemGeometry( itemName ) Caches an item geometry. | |
|
|
Syntax: Action.CacheItemSound( itemName ) Caches an item sound. | |
|
|
Syntax: Action.ClearEntityTags( entityId ) Clears the tag for the specified entity. | |
|
|
Syntax: Action.ClearStaticTag( entityId, staticId ) Clears the specified static tag for the specified entity. | |
|
|
Syntax: Action.ConnectToServer( server ) Connects to the specified server. | |
|
|
Syntax: Action.CreateGameObjectForEntity( entityId ) Creates a game object for the specified entity. | |
|
|
Syntax: Action.DestroyRangeSignaling( entityId ) | |
|
|
Syntax: Action.DisableSignalTimer( entityId, sText ) Disables the signal timer. | |
|
|
Syntax: Action.DontSyncPhysics( entityId ) Doesn't sync physics for the specified entity. | |
|
|
Syntax: Action.EnableRangeSignaling( entityId, bEnable ) Enable/Disable range signalling for the specified entity. | |
|
|
Syntax: Action.EnableSignalTimer( entityId, sText ) Enables the signal timer. | |
|
|
Syntax: Action.ForceGameObjectUpdate( entityId, force ) Forces the game object to be updated. | |
|
|
Syntax: Action.GetClassName( classId ) Returns the matching class name if available for specified classId. | |
 |
This is GetMemoryUsage, a member of class CScriptBindAction. | |
|
|
Syntax: Action.GetPlayerList() Checks the current players list. | |
|
|
Syntax: Action.GetServer( number ) Gets the server. | |
|
|
Syntax: Action.GetServerTime() Gets the current time on the server. | |
|
|
Syntax: Action.GetWaterInfo( pos ) Gets information about the water at the position pos. | |
|
|
Syntax: Action.HasAI( entityId ) Returns if the entity has an AI object associated to it, meaning it has been registered with the AI System | |
|
|
Syntax: Action.IsChannelOnHold( channelId ) Checks if the specified channel is on hold. | |
|
|
Syntax: Action.IsChannelSpecial() Gets if the channel is a special one. | |
|
|
Syntax: Action.IsClient() Checks if the current script runs on a client. | |
|
|
Syntax: Action.IsGameObjectProbablyVisible( gameObject ) Checks if an object is probably visible. | |
|
|
Syntax: Action.IsGameStarted() Checks if the game is started. | |
|
|
Syntax: Action.IsImmersivenessEnabled() Gets if the immersive multiplayer is enabled. | |
|
|
Syntax: Action.IsRMIServer() Checks if the current script is running on an RMI (Remote Method Invocation) server. | |
|
|
Syntax: Action.IsServer() Checks if the current script runs on a server. | |
|
|
Syntax: Action.LoadXML(definitionFile, dataFile ) | |
|
|
Syntax: Action.PauseGame( pause ) Puts the game into pause mode. | |
|
|
Syntax: Action.Persistant2DText( text, size, color, name, timeout ) Adds a persistent 2D text. | |
|
|
Syntax: Action.PersistantArrow( pos, radius, dir, color, name, timeout ) Adds a persistent arrow to the world. | |
|
|
Syntax: Action.PersistantEntityTag( entityId, text ) Adds a persistent entity tag. Required Params: entityId, const char *text Optional Params: float size, Vec3 color, float visibleTime, float fadeTime, float viewDistance, const char* staticId, int columnNum, const char* contextTag | |
|
|
Syntax: Action.PersistantLine( start, end, color, name, timeout ) Adds a persistent line to the world. | |
|
|
Syntax: Action.PersistantSphere( pos, radius, color, name, timeout ) Adds a persistent sphere to the world. | |
|
|
Syntax: Action.PreLoadADB( adbFileName ) Use this function to pre-cache ADB files. Pre-load a mannequin ADB file. In: The function handler (NULL is invalid!) In: The name of the ADB file. | |
|
|
Syntax: Action.RefreshPings() Refreshes pings for all the servers listed. | |
|
|
Syntax: Action.RegisterWithAI() Registers the entity to AI System, creating an AI object associated to it (MATT) Moved here from ScriptBindAI when that was moved to the AI system {2008/02/15:15:23:16 | |
|
|
This is Release, a member of class CScriptBindAction. | |
|
|
Syntax: Action.ResetRangeSignaling( entityId ) | |
|
|
Syntax: Action.ResetSignalTimer( entityId, sText ) Resets the rate for the signal timer. | |
|
|
Syntax: Action.ResetToNormalCamera() Resets the camera to the last valid view stored. | |
|
|
Syntax: Action.SaveXML(definitionFile, dataFile, dataTable) | |
|
|
Syntax: Action.SendGameplayEvent( entityId, event ) Sends an event for the gameplay. | |
|
|
Syntax: Action.SetAimQueryMode( entityId, mode ) 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. | |
|
|
Syntax: Action.SetNetworkParent( entityId, parentId ) Sets the network parent. | |
|
|
Syntax: Action.SetSignalTimerRate( entityId, sText, fRateMin, fRateMax ) Sets the rate for the signal timer. | |
|
|
Syntax: Action.SetViewCamera() Saves the previous valid view and override it with the current camera settings. |
|
Copyright (c) 2012. All rights reserved.
|
