cz.cuni.amis.pogamut.udk.communication.messages.gbcommands
Class UseTrigger

java.lang.Object
  cz.cuni.amis.pogamut.base.communication.messages.CommandMessage
      cz.cuni.amis.pogamut.udk.communication.messages.gbcommands.UseTrigger

public class UseTrigger
extends CommandMessage

Causes bot to perform usage of a specified trigger. Response to this action is carried by the TRGUSED (TriggerUsed) info message Corresponding GameBots command is USETRG.

Field Summary

protected boolean	IgnoreEventInteractionDistance If true, the interaction distance property of the used events associated with the trigger is ignored (ie.
protected UnrealId	Target The trigger object to use.
protected boolean	UsableOnly If true, the used events associated with the trigger will be checked for their respective activation conditions.

Constructor Summary

UseTrigger()
Creates new instance of command UseTrigger.

UseTrigger(UnrealId Target, boolean UsableOnly, boolean IgnoreEventInteractionDistance)
Creates new instance of command UseTrigger.

UseTrigger(UseTrigger original)
Cloning constructor.

Method Summary

UnrealId	getTarget() The trigger object to use.
boolean	isIgnoreEventInteractionDistance() If true, the interaction distance property of the used events associated with the trigger is ignored (ie.
boolean	isUsableOnly() If true, the used events associated with the trigger will be checked for their respective activation conditions.
UseTrigger	setIgnoreEventInteractionDistance(boolean IgnoreEventInteractionDistance) If true, the interaction distance property of the used events associated with the trigger is ignored (ie.
UseTrigger	setTarget(UnrealId Target) The trigger object to use.
UseTrigger	setUsableOnly(boolean UsableOnly) If true, the used events associated with the trigger will be checked for their respective activation conditions.
String	toHtmlString()
String	toMessage()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

Target

protected UnrealId Target

The trigger object to use.

UsableOnly

protected boolean UsableOnly

If true, the used events associated with the trigger will be checked for their respective activation conditions.

IgnoreEventInteractionDistance

protected boolean IgnoreEventInteractionDistance

If true, the interaction distance property of the used events associated with the trigger is ignored (ie. all are tried for activation). The trigger's CylinderComponent still needs to collide with the player.

Constructor Detail

UseTrigger

public UseTrigger(UnrealId Target,
                  boolean UsableOnly,
                  boolean IgnoreEventInteractionDistance)

Creates new instance of command UseTrigger. Causes bot to perform usage of a specified trigger. Response to this action is carried by the TRGUSED (TriggerUsed) info message Corresponding GameBots message for this command is USETRG.

Parameters:

Target - The trigger object to use.

UsableOnly - If true, the used events associated with the trigger will be checked for their respective activation conditions.

IgnoreEventInteractionDistance - If true, the interaction distance property of the used events associated with the trigger is ignored (ie. all are tried for activation). The trigger's CylinderComponent still needs to collide with the player.

UseTrigger

public UseTrigger()

Creates new instance of command UseTrigger. Causes bot to perform usage of a specified trigger. Response to this action is carried by the TRGUSED (TriggerUsed) info message Corresponding GameBots message for this command is USETRG.

WARNING: this is empty-command constructor, you have to use setters to fill it up!

UseTrigger

public UseTrigger(UseTrigger original)

Cloning constructor.

Method Detail

getTarget

public UnrealId getTarget()

The trigger object to use.

setTarget

public UseTrigger setTarget(UnrealId Target)

The trigger object to use.

isUsableOnly

public boolean isUsableOnly()

If true, the used events associated with the trigger will be checked for their respective activation conditions.

setUsableOnly

public UseTrigger setUsableOnly(boolean UsableOnly)

If true, the used events associated with the trigger will be checked for their respective activation conditions.

isIgnoreEventInteractionDistance

public boolean isIgnoreEventInteractionDistance()

If true, the interaction distance property of the used events associated with the trigger is ignored (ie. all are tried for activation). The trigger's CylinderComponent still needs to collide with the player.

setIgnoreEventInteractionDistance

public UseTrigger setIgnoreEventInteractionDistance(boolean IgnoreEventInteractionDistance)

If true, the interaction distance property of the used events associated with the trigger is ignored (ie. all are tried for activation). The trigger's CylinderComponent still needs to collide with the player.

toString

public String toString()

Overrides:

toString in class CommandMessage

toHtmlString

public String toHtmlString()

toMessage

public String toMessage()