delete(); documentation is wrong

tomangelo2 commented 6 years ago

Official documentation states:

delete() - Damages the object, 1: object's ID, 2: magnifyDamage multiplier, without 2 the object explodes

so it looks like second parameter should only increase/decrease amount of damage to object. But values >1 doesn't just do incredible damage, instead it results in buildings flying into space, reversed build animation, or game just crash because, for example, it gives up trying to (probably) drown a BotFactory:

Assertion failed!

Program: C:\Program Files (x86)\colobot\wuasne\colobot.exe
File: C:/Users/student/repo/colobot/src/object/old_object.cpp, Line 445

Expression: type != DestructionType::Drowned || m_type == OBJECT_HUMAN

Either we should improve documentation to match it to actual effects, or fix those crazy behaviors. In any case, this function shouldn't crash whole game.

krzys-h commented 6 years ago

The docs are wrong, second argument is explosion type

X64E commented 2 years ago

@MrSimbax May be move this issue to https://github.com/colobot/colobot-data repo ?

colobot / colobot-data

delete(); documentation is wrong #71